Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ancestorId globally unique identifier Required

Guid ID for departments, individuals, metrics, organizations, projects, and tasks.

deleted byte

Add ?deleted=0, 1, or 2 for not deleted, deleted, or all.

Body Parameters

None.

Response Information

Resource Description (RelatedLink)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID globally unique identifier Required on Update

ID of the related link.

AncestorID globally unique identifier Required on Create

ID of the ancester for the related links.

Name string Required

Name of the related link. (Max length 255 characters)

Rank integer Required

Rank of the related link.

URL string Required

URL of the related link.

Description string Required

Description of the related link.

Deleted boolean ReadOnly

Deleted status of the related link.

DeletedByRef boolean ReadOnly

Deleted by reference status of the related link.

Response Formats

application/xml, text/xml

Sample
<RelatedLink xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>3272e5cc-c2d4-4b2f-8b3e-97ea1fa5c6f2</ID>
  <AncestorID>9fb5d743-e52d-42c9-81cf-528a3ec45d43</AncestorID>
  <Name>sample string 1</Name>
  <Rank>1</Rank>
  <URL>sample string 2</URL>
  <Description>sample string 3</Description>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
</RelatedLink>

application/json, text/json

Sample
{
  "ID": "3272e5cc-c2d4-4b2f-8b3e-97ea1fa5c6f2",
  "AncestorID": "9fb5d743-e52d-42c9-81cf-528a3ec45d43",
  "Name": "sample string 1",
  "Rank": 1,
  "URL": "sample string 2",
  "Description": "sample string 3",
  "Deleted": true,
  "DeletedByRef": true
}