POST api/businessmodules/{sourceListId}/entities/{sourceItemId}/relations

Create relation(s) for an entity

Request Information

URI Parameters

Name	Description	Type	Additional information
sourceListId		globally unique identifier	Required
sourceItemId		integer	Required

Body Parameters

WorkPoint365.WebAPI.Model.Relations.CreateEntityRelationsRequest

Name	Description	Type	Additional information
Relations		Collection of WorkPoint365.WebAPI.Model.Relations.CreateEntityRelationRequestItem	Required

Request Formats

application/json, text/json

Sample:

{
  "Relations": [
    {
      "TargetListId": "7758d8ae-fe87-4bf8-ae52-495238875e54",
      "TargetItemId": 2,
      "SourceRelationTypeId": 3,
      "TargetRelationTypeId": 4,
      "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-08-23T11:59:59.6231736+00:00",
      "EndDate": "2026-08-23T11:59:59.6231736+00:00",
      "Description": "sample string 5"
    },
    {
      "TargetListId": "7758d8ae-fe87-4bf8-ae52-495238875e54",
      "TargetItemId": 2,
      "SourceRelationTypeId": 3,
      "TargetRelationTypeId": 4,
      "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-08-23T11:59:59.6231736+00:00",
      "EndDate": "2026-08-23T11:59:59.6231736+00:00",
      "Description": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<CreateEntityRelationsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model.Relations">
  <Relations>
    <CreateEntityRelationRequestItem>
      <Description>sample string 5</Description>
      <EndDate>2026-08-23T11:59:59.6231736+00:00</EndDate>
      <Responsible xmlns:d4p1="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
        <d4p1:Email>sample string 3</d4p1:Email>
        <d4p1:LookupId>1</d4p1:LookupId>
        <d4p1:LookupValue>sample string 2</d4p1:LookupValue>
        <d4p1:PrincipalType>sample string 5</d4p1:PrincipalType>
        <d4p1:SourceUrl>sample string 6</d4p1:SourceUrl>
        <d4p1:UserPrincipalName>sample string 4</d4p1:UserPrincipalName>
      </Responsible>
      <SourceRelationTypeId>3</SourceRelationTypeId>
      <StartDate>2026-08-23T11:59:59.6231736+00:00</StartDate>
      <TargetItemId>2</TargetItemId>
      <TargetListId>7758d8ae-fe87-4bf8-ae52-495238875e54</TargetListId>
      <TargetRelationTypeId>4</TargetRelationTypeId>
    </CreateEntityRelationRequestItem>
    <CreateEntityRelationRequestItem>
      <Description>sample string 5</Description>
      <EndDate>2026-08-23T11:59:59.6231736+00:00</EndDate>
      <Responsible xmlns:d4p1="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
        <d4p1:Email>sample string 3</d4p1:Email>
        <d4p1:LookupId>1</d4p1:LookupId>
        <d4p1:LookupValue>sample string 2</d4p1:LookupValue>
        <d4p1:PrincipalType>sample string 5</d4p1:PrincipalType>
        <d4p1:SourceUrl>sample string 6</d4p1:SourceUrl>
        <d4p1:UserPrincipalName>sample string 4</d4p1:UserPrincipalName>
      </Responsible>
      <SourceRelationTypeId>3</SourceRelationTypeId>
      <StartDate>2026-08-23T11:59:59.6231736+00:00</StartDate>
      <TargetItemId>2</TargetItemId>
      <TargetListId>7758d8ae-fe87-4bf8-ae52-495238875e54</TargetListId>
      <TargetRelationTypeId>4</TargetRelationTypeId>
    </CreateEntityRelationRequestItem>
  </Relations>
</CreateEntityRelationsRequest>

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.