POST api/v1.0/ResourceLibrary/AddToFavorites?documentKey={documentKey}

Add the specified Document to the Authenticated User's Favorite List.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
documentKey

DocumentKey of a Document.

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

DocumentFavorite
NameDescriptionTypeAdditional information
ContactKey

globally unique identifier

None.
DocumentKey

globally unique identifier

None.
CreatedOn

date

None.

Response Formats

application/json, text/json

Sample: 
{
  "ContactKey": "1fa9bc78-a7ab-4296-9e22-c94ce0ce2241",
  "DocumentKey": "cee8fd54-b65e-4760-9f10-b49de0075f4c",
  "CreatedOn": "2024-12-26T11:16:04.4545261Z"
}

application/xml, text/xml

Sample: 
<DocumentFavorite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.ResourceLibrary">
  <ContactKey>1fa9bc78-a7ab-4296-9e22-c94ce0ce2241</ContactKey>
  <CreatedOn>2024-12-26T06:16:04.4545261-05:00</CreatedOn>
  <DocumentKey>cee8fd54-b65e-4760-9f10-b49de0075f4c</DocumentKey>
</DocumentFavorite>