POST api/Relations

Create relation(s)

Request Information

URI Parameters

None.

Body Parameters

WorkPoint365.WebAPI.Model.CreateRelationViewModel

Name	Type	Additional information
BuilderRelations	Collection of WorkPoint365.WebAPI.Model.RelationItemBuilderViewModel	None.
SourceListId	globally unique identifier	Required
SourceItemId	integer	Required
StepInputRelations	Collection of WorkPoint365.WebAPI.Model.RelationItemInputModel	None.

Request Formats

application/json, text/json

Sample:

{
  "BuilderRelations": [
    {
      "ListId": "4580216e-5d82-4c10-92f4-c3f4aa320a41",
      "EntityId": 2,
      "title": "sample string 3",
      "TargetRelationTypeId": 4,
      "SourceRelationTypeId": 5,
      "Responsible": {
        "LookupId": 1,
        "LookupValue": "sample string 2",
        "Email": "sample string 3",
        "UserPrincipalName": "sample string 4",
        "PrincipalType": "sample string 5",
        "SourceUrl": "sample string 6"
      },
      "StartDate": "2026-10-16T23:59:28.1564001+00:00",
      "EndDate": "2026-10-16T23:59:28.1564001+00:00",
      "Description": "sample string 6",
      "RelationId": 7
    },
    {
      "ListId": "4580216e-5d82-4c10-92f4-c3f4aa320a41",
      "EntityId": 2,
      "title": "sample string 3",
      "TargetRelationTypeId": 4,
      "SourceRelationTypeId": 5,
      "Responsible": {
        "LookupId": 1,
        "LookupValue": "sample string 2",
        "Email": "sample string 3",
        "UserPrincipalName": "sample string 4",
        "PrincipalType": "sample string 5",
        "SourceUrl": "sample string 6"
      },
      "StartDate": "2026-10-16T23:59:28.1564001+00:00",
      "EndDate": "2026-10-16T23:59:28.1564001+00:00",
      "Description": "sample string 6",
      "RelationId": 7
    }
  ],
  "SourceListId": "518c52b6-3136-4c0b-b8b4-fe1f17d9f9b8",
  "SourceItemId": 2,
  "StepInputRelations": [
    {
      "SourceRelationItem": [
        {
          "Id": 1,
          "Title": "sample string 2",
          "ListId": "0a76dfb9-d05c-4b8b-91b6-11da2785f9ab"
        },
        {
          "Id": 1,
          "Title": "sample string 2",
          "ListId": "0a76dfb9-d05c-4b8b-91b6-11da2785f9ab"
        }
      ],
      "TargetRelationItems": [
        {
          "Id": 1,
          "Title": "sample string 2",
          "ListId": "0a76dfb9-d05c-4b8b-91b6-11da2785f9ab"
        },
        {
          "Id": 1,
          "Title": "sample string 2",
          "ListId": "0a76dfb9-d05c-4b8b-91b6-11da2785f9ab"
        }
      ],
      "title": "sample string 1",
      "TargetRelationTypeId": 2,
      "SourceRelationTypeId": 3,
      "Responsible": {
        "LookupId": 1,
        "LookupValue": "sample string 2",
        "Email": "sample string 3",
        "UserPrincipalName": "sample string 4",
        "PrincipalType": "sample string 5",
        "SourceUrl": "sample string 6"
      },
      "StartDate": "2026-10-16T23:59:28.1564001+00:00",
      "EndDate": "2026-10-16T23:59:28.1564001+00:00",
      "Description": "sample string 4",
      "RelationId": 5
    },
    {
      "SourceRelationItem": [
        {
          "Id": 1,
          "Title": "sample string 2",
          "ListId": "0a76dfb9-d05c-4b8b-91b6-11da2785f9ab"
        },
        {
          "Id": 1,
          "Title": "sample string 2",
          "ListId": "0a76dfb9-d05c-4b8b-91b6-11da2785f9ab"
        }
      ],
      "TargetRelationItems": [
        {
          "Id": 1,
          "Title": "sample string 2",
          "ListId": "0a76dfb9-d05c-4b8b-91b6-11da2785f9ab"
        },
        {
          "Id": 1,
          "Title": "sample string 2",
          "ListId": "0a76dfb9-d05c-4b8b-91b6-11da2785f9ab"
        }
      ],
      "title": "sample string 1",
      "TargetRelationTypeId": 2,
      "SourceRelationTypeId": 3,
      "Responsible": {
        "LookupId": 1,
        "LookupValue": "sample string 2",
        "Email": "sample string 3",
        "UserPrincipalName": "sample string 4",
        "PrincipalType": "sample string 5",
        "SourceUrl": "sample string 6"
      },
      "StartDate": "2026-10-16T23:59:28.1564001+00:00",
      "EndDate": "2026-10-16T23:59:28.1564001+00:00",
      "Description": "sample string 4",
      "RelationId": 5
    }
  ]
}

application/xml, text/xml

Sample:

<CreateRelationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <SourceItemId>2</SourceItemId>
  <SourceListId>518c52b6-3136-4c0b-b8b4-fe1f17d9f9b8</SourceListId>
  <StepInputRelations>
    <RelationItemInputModel>
      <Description>sample string 4</Description>
      <EndDate>2026-10-16T23:59:28.1564001+00:00</EndDate>
      <RelationId>5</RelationId>
      <Responsible>
        <Email>sample string 3</Email>
        <LookupId>1</LookupId>
        <LookupValue>sample string 2</LookupValue>
        <PrincipalType>sample string 5</PrincipalType>
        <SourceUrl>sample string 6</SourceUrl>
        <UserPrincipalName>sample string 4</UserPrincipalName>
      </Responsible>
      <SourceRelationTypeId>3</SourceRelationTypeId>
      <StartDate>2026-10-16T23:59:28.1564001+00:00</StartDate>
      <TargetRelationTypeId>2</TargetRelationTypeId>
      <Title>sample string 1</Title>
      <SourceRelationItem>
        <RelationModel>
          <Id>1</Id>
          <ListId>0a76dfb9-d05c-4b8b-91b6-11da2785f9ab</ListId>
          <Title>sample string 2</Title>
        </RelationModel>
        <RelationModel>
          <Id>1</Id>
          <ListId>0a76dfb9-d05c-4b8b-91b6-11da2785f9ab</ListId>
          <Title>sample string 2</Title>
        </RelationModel>
      </SourceRelationItem>
      <TargetRelationItems>
        <RelationModel>
          <Id>1</Id>
          <ListId>0a76dfb9-d05c-4b8b-91b6-11da2785f9ab</ListId>
          <Title>sample string 2</Title>
        </RelationModel>
        <RelationModel>
          <Id>1</Id>
          <ListId>0a76dfb9-d05c-4b8b-91b6-11da2785f9ab</ListId>
          <Title>sample string 2</Title>
        </RelationModel>
      </TargetRelationItems>
    </RelationItemInputModel>
    <RelationItemInputModel>
      <Description>sample string 4</Description>
      <EndDate>2026-10-16T23:59:28.1564001+00:00</EndDate>
      <RelationId>5</RelationId>
      <Responsible>
        <Email>sample string 3</Email>
        <LookupId>1</LookupId>
        <LookupValue>sample string 2</LookupValue>
        <PrincipalType>sample string 5</PrincipalType>
        <SourceUrl>sample string 6</SourceUrl>
        <UserPrincipalName>sample string 4</UserPrincipalName>
      </Responsible>
      <SourceRelationTypeId>3</SourceRelationTypeId>
      <StartDate>2026-10-16T23:59:28.1564001+00:00</StartDate>
      <TargetRelationTypeId>2</TargetRelationTypeId>
      <Title>sample string 1</Title>
      <SourceRelationItem>
        <RelationModel>
          <Id>1</Id>
          <ListId>0a76dfb9-d05c-4b8b-91b6-11da2785f9ab</ListId>
          <Title>sample string 2</Title>
        </RelationModel>
        <RelationModel>
          <Id>1</Id>
          <ListId>0a76dfb9-d05c-4b8b-91b6-11da2785f9ab</ListId>
          <Title>sample string 2</Title>
        </RelationModel>
      </SourceRelationItem>
      <TargetRelationItems>
        <RelationModel>
          <Id>1</Id>
          <ListId>0a76dfb9-d05c-4b8b-91b6-11da2785f9ab</ListId>
          <Title>sample string 2</Title>
        </RelationModel>
        <RelationModel>
          <Id>1</Id>
          <ListId>0a76dfb9-d05c-4b8b-91b6-11da2785f9ab</ListId>
          <Title>sample string 2</Title>
        </RelationModel>
      </TargetRelationItems>
    </RelationItemInputModel>
  </StepInputRelations>
  <BuilderRelations>
    <RelationItemBuilderViewModel>
      <Description>sample string 6</Description>
      <EndDate>2026-10-16T23:59:28.1564001+00:00</EndDate>
      <RelationId>7</RelationId>
      <Responsible>
        <Email>sample string 3</Email>
        <LookupId>1</LookupId>
        <LookupValue>sample string 2</LookupValue>
        <PrincipalType>sample string 5</PrincipalType>
        <SourceUrl>sample string 6</SourceUrl>
        <UserPrincipalName>sample string 4</UserPrincipalName>
      </Responsible>
      <SourceRelationTypeId>5</SourceRelationTypeId>
      <StartDate>2026-10-16T23:59:28.1564001+00:00</StartDate>
      <TargetRelationTypeId>4</TargetRelationTypeId>
      <Title>sample string 3</Title>
      <EntityId>2</EntityId>
      <ListId>4580216e-5d82-4c10-92f4-c3f4aa320a41</ListId>
    </RelationItemBuilderViewModel>
    <RelationItemBuilderViewModel>
      <Description>sample string 6</Description>
      <EndDate>2026-10-16T23:59:28.1564001+00:00</EndDate>
      <RelationId>7</RelationId>
      <Responsible>
        <Email>sample string 3</Email>
        <LookupId>1</LookupId>
        <LookupValue>sample string 2</LookupValue>
        <PrincipalType>sample string 5</PrincipalType>
        <SourceUrl>sample string 6</SourceUrl>
        <UserPrincipalName>sample string 4</UserPrincipalName>
      </Responsible>
      <SourceRelationTypeId>5</SourceRelationTypeId>
      <StartDate>2026-10-16T23:59:28.1564001+00:00</StartDate>
      <TargetRelationTypeId>4</TargetRelationTypeId>
      <Title>sample string 3</Title>
      <EntityId>2</EntityId>
      <ListId>4580216e-5d82-4c10-92f4-c3f4aa320a41</ListId>
    </RelationItemBuilderViewModel>
  </BuilderRelations>
</CreateRelationViewModel>

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.