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": "fa4acce7-111b-4436-b091-b700949a68ac",
  "DocumentKey": "eb72971b-5b0f-4a00-8cd7-f777cdd47b1a",
  "CreatedOn": "2024-04-20T15:38:52.1847379Z"
}

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>fa4acce7-111b-4436-b091-b700949a68ac</ContactKey>
  <CreatedOn>2024-04-20T11:38:52.1847379-04:00</CreatedOn>
  <DocumentKey>eb72971b-5b0f-4a00-8cd7-f777cdd47b1a</DocumentKey>
</DocumentFavorite>