POST api/v1.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.

RelatedLinkRequest

Name	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.

RelatedLink

Name	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": "b89f2a90-d257-47e2-a415-62c4ef5746e4",
  "ItemKey": "e2b63fff-595d-4e04-a42b-6cc8353f59c6",
  "Url": "sample string 3",
  "Contributor": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "cf4dbcff-ffb2-4972-b536-8a29a7ee3569",
    "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-12-26T23:20:00.1243359Z",
    "UpdatedByContactKey": "e534ee20-d339-4e6f-b7ff-82ae583468d8",
    "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-12-26T23:20:00.1243359Z"
  },
  "CreatedOn": "2024-12-26T23:20:00.1243359Z"
}

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-12-26T18:20:00.1243359-05:00</AgreedToTermsDateTime>
    <CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey>
    <CompanyName>sample string 12</CompanyName>
    <CompanyTitle>sample string 13</CompanyTitle>
    <ContactKey>cf4dbcff-ffb2-4972-b536-8a29a7ee3569</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>e534ee20-d339-4e6f-b7ff-82ae583468d8</UpdatedByContactKey>
    <UpdatedOn>2024-12-26T18:20:00.1243359-05:00</UpdatedOn>
  </Contributor>
  <CreatedOn>2024-12-26T18:20:00.1243359-05:00</CreatedOn>
  <ItemKey>e2b63fff-595d-4e04-a42b-6cc8353f59c6</ItemKey>
  <RelatedLinkKey>b89f2a90-d257-47e2-a415-62c4ef5746e4</RelatedLinkKey>
  <Url>sample string 3</Url>
</RelatedLink>