POST api/v2.0/ResourceLibrary/AddRelatedLink?documentKey={documentKey}
Adds the specified URL as a RelatedLink to the specified Document.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
documentKey |
DocumentKey of the Document to which the Related Link should be added. |
globally unique identifier |
Required |
Body Parameters
URL to add as the Related Link.
RelatedLinkRequestName | Description | Type | Additional information |
---|---|---|---|
Url | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Url": "sample string 1" }
application/xml, text/xml
Sample:
<RelatedLinkRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Request"> <Url>sample string 1</Url> </RelatedLinkRequest>
Response Information
Resource Description
RelatedLinkKey (Guid) of the newly created RelatedLink.
RelatedLinkName | Description | Type | Additional information |
---|---|---|---|
RelatedLinkKey | globally unique identifier |
None. |
|
ItemKey | globally unique identifier |
None. |
|
Url | string |
None. |
|
Contributor | ContactConcise |
None. |
|
CreatedOn | date |
None. |
Response Formats
application/json, text/json
Sample:
{ "RelatedLinkKey": "35a40582-61c0-4711-a761-7242c32e458f", "ItemKey": "27b0dc75-1faf-4beb-827c-475a498e7f6b", "Url": "sample string 3", "Contributor": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "3c215472-6327-4b0b-ae46-08f28a536d7d", "FirstName": "sample string 4", "LastName": "sample string 5", "DisplayName": "sample string 6", "EmailAddress": "sample string 7", "ContactStatusCode": "sample string 8", "PrefixCode": "sample string 9", "UpdatedOn": "2023-10-04T05:53:01.3885142Z", "UpdatedByContactKey": "fa9ff8f8-ce60-4146-86a6-f0fb958f96af", "CompanyName": "sample string 12", "CompanyTitle": "sample string 13", "SuffixCode": "sample string 14", "Designation": "sample string 15", "LegacyContactKey": "sample string 16", "InformalName": "sample string 17", "MiddleName": "sample string 18", "IsCompany": true, "CompanyLegacyContactKey": "sample string 20", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "LargePictureUrl": "sample string 24", "AgreedToTermsDateTime": "2023-10-04T05:53:01.3885142Z" }, "CreatedOn": "2023-10-04T05:53:01.4041491Z" }
application/xml, text/xml
Sample:
<RelatedLink xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise"> <Contributor> <AMSDirectoryOptOut>true</AMSDirectoryOptOut> <AgreedToTermsDateTime>2023-10-04T01:53:01.3885142-04:00</AgreedToTermsDateTime> <CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey> <CompanyName>sample string 12</CompanyName> <CompanyTitle>sample string 13</CompanyTitle> <ContactKey>3c215472-6327-4b0b-ae46-08f28a536d7d</ContactKey> <ContactStatusCode>sample string 8</ContactStatusCode> <Designation>sample string 15</Designation> <DisplayName>sample string 6</DisplayName> <EmailAddress>sample string 7</EmailAddress> <FirstName>sample string 4</FirstName> <HLContactMeOptOut>true</HLContactMeOptOut> <HLDirectoryOptOut>true</HLDirectoryOptOut> <InformalName>sample string 17</InformalName> <IsCompany>true</IsCompany> <LargePictureUrl>sample string 24</LargePictureUrl> <LastName>sample string 5</LastName> <LegacyContactKey>sample string 16</LegacyContactKey> <LinkToProfile>sample string 1</LinkToProfile> <MiddleName>sample string 18</MiddleName> <PictureUrl>sample string 2</PictureUrl> <PrefixCode>sample string 9</PrefixCode> <SuffixCode>sample string 14</SuffixCode> <UpdatedByContactKey>fa9ff8f8-ce60-4146-86a6-f0fb958f96af</UpdatedByContactKey> <UpdatedOn>2023-10-04T01:53:01.3885142-04:00</UpdatedOn> </Contributor> <CreatedOn>2023-10-04T01:53:01.4041491-04:00</CreatedOn> <ItemKey>27b0dc75-1faf-4beb-827c-475a498e7f6b</ItemKey> <RelatedLinkKey>35a40582-61c0-4711-a761-7242c32e458f</RelatedLinkKey> <Url>sample string 3</Url> </RelatedLink>