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

Create one relation 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.CreateEntityRelationRequestItem

Name	Type	Additional information
TargetListId	globally unique identifier	Required
TargetItemId	integer	Required
SourceRelationTypeId	integer	Required
TargetRelationTypeId	integer	Required
Responsible	WorkPoint365.WebAPI.Model.ProcessFieldUserValue	None.
StartDate	date	None.
EndDate	date	None.
Description	string	None.

Request Formats

application/json, text/json

Sample:

{
  "TargetListId": "d8d056e6-858e-467d-9588-15f9582d94f3",
  "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.7481674+00:00",
  "EndDate": "2026-08-23T11:59:59.7481674+00:00",
  "Description": "sample string 5"
}

application/xml, text/xml

Sample:

<CreateEntityRelationRequestItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model.Relations">
  <Description>sample string 5</Description>
  <EndDate>2026-08-23T11:59:59.7481674+00:00</EndDate>
  <Responsible xmlns:d2p1="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
    <d2p1:Email>sample string 3</d2p1:Email>
    <d2p1:LookupId>1</d2p1:LookupId>
    <d2p1:LookupValue>sample string 2</d2p1:LookupValue>
    <d2p1:PrincipalType>sample string 5</d2p1:PrincipalType>
    <d2p1:SourceUrl>sample string 6</d2p1:SourceUrl>
    <d2p1:UserPrincipalName>sample string 4</d2p1:UserPrincipalName>
  </Responsible>
  <SourceRelationTypeId>3</SourceRelationTypeId>
  <StartDate>2026-08-23T11:59:59.7481674+00:00</StartDate>
  <TargetItemId>2</TargetItemId>
  <TargetListId>d8d056e6-858e-467d-9588-15f9582d94f3</TargetListId>
  <TargetRelationTypeId>4</TargetRelationTypeId>
</CreateEntityRelationRequestItem>

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.