PUT relatedlinks/{id}

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
id `globally unique identifier` Required Guid ID of the related link to be updated.	`globally unique identifier` Required Guid ID of the related link to be updated.

Body Parameters (RelatedLink)

This object takes all the parameters needed to update an accountability.

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
ID `globally unique identifier` Required on Update ID of the related link.	`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.	`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)	`string` Required Name of the related link. (Max length 255 characters)
Rank `integer` Required Rank of the related link.	`integer` Required Rank of the related link.
URL `string` Required URL of the related link.	`string` Required URL of the related link.
Description `string` Required Description of the related link.	`string` Required Description of the related link.
Deleted `boolean` ReadOnly Deleted status of the related link.	`boolean` ReadOnly Deleted status of the related link.
DeletedByRef `boolean` ReadOnly Deleted by reference status of the related link.	`boolean` ReadOnly Deleted by reference status of the related link.

Request Formats

application/xml, text/xml

Sample

<RelatedLink xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>b53762b3-8455-4c09-ba6a-51cf11c8ee9c</ID>
  <AncestorID>05b92dca-733a-4469-9611-d5bc2bae4983</AncestorID>
  <Name>sample string 1</Name>
  <Rank>1</Rank>
  <URL>sample string 2</URL>
  <Description>sample string 3</Description>
</RelatedLink>

application/json, text/json

Sample

{
  "ID": "b53762b3-8455-4c09-ba6a-51cf11c8ee9c",
  "AncestorID": "05b92dca-733a-4469-9611-d5bc2bae4983",
  "Name": "sample string 1",
  "Rank": 1,
  "URL": "sample string 2",
  "Description": "sample string 3"
}

Response Information

Resource Description (RelatedLink)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
ID `globally unique identifier` Required on Update ID of the related link.	`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.	`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)	`string` Required Name of the related link. (Max length 255 characters)
Rank `integer` Required Rank of the related link.	`integer` Required Rank of the related link.
URL `string` Required URL of the related link.	`string` Required URL of the related link.
Description `string` Required Description of the related link.	`string` Required Description of the related link.
Deleted `boolean` ReadOnly Deleted status of the related link.	`boolean` ReadOnly Deleted status of the related link.
DeletedByRef `boolean` ReadOnly Deleted by reference status of the related link.	`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>942bf47c-1cf3-44cc-b55f-6ec26c95fe97</ID>
  <AncestorID>2ed89879-d007-41fc-9d49-dfd4a2e2158f</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": "942bf47c-1cf3-44cc-b55f-6ec26c95fe97",
  "AncestorID": "2ed89879-d007-41fc-9d49-dfd4a2e2158f",
  "Name": "sample string 1",
  "Rank": 1,
  "URL": "sample string 2",
  "Description": "sample string 3",
  "Deleted": true,
  "DeletedByRef": true
}