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": "a5f3a372-ebe1-4b05-8472-cddf15aaa4e2", "ItemKey": "f8f3c176-d323-4ca7-bdc7-bb0f61a54731", "Url": "sample string 3", "Contributor": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "495a4c11-cec1-4476-afe9-2786f9e0c8a8", "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": "2024-09-07T22:26:52.8832314Z", "UpdatedByContactKey": "01c98f42-05ba-4738-acf4-0b3cc498d0ba", "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": "2024-09-07T22:26:52.8832314Z" }, "CreatedOn": "2024-09-07T22:26:52.8832314Z" }
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>2024-09-07T18:26:52.8832314-04:00</AgreedToTermsDateTime> <CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey> <CompanyName>sample string 12</CompanyName> <CompanyTitle>sample string 13</CompanyTitle> <ContactKey>495a4c11-cec1-4476-afe9-2786f9e0c8a8</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>01c98f42-05ba-4738-acf4-0b3cc498d0ba</UpdatedByContactKey> <UpdatedOn>2024-09-07T18:26:52.8832314-04:00</UpdatedOn> </Contributor> <CreatedOn>2024-09-07T18:26:52.8832314-04:00</CreatedOn> <ItemKey>f8f3c176-d323-4ca7-bdc7-bb0f61a54731</ItemKey> <RelatedLinkKey>a5f3a372-ebe1-4b05-8472-cddf15aaa4e2</RelatedLinkKey> <Url>sample string 3</Url> </RelatedLink>