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": "9cbb00cd-4650-494a-8491-0909dbc80add",
  "DocumentKey": "d1590ff3-dad6-44fa-83d3-30cdc63f5d2e",
  "CreatedOn": "2020-08-05T19:37:23.9280688Z"
}

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>9cbb00cd-4650-494a-8491-0909dbc80add</ContactKey>
  <CreatedOn>2020-08-05T15:37:23.9280688-04:00</CreatedOn>
  <DocumentKey>d1590ff3-dad6-44fa-83d3-30cdc63f5d2e</DocumentKey>
</DocumentFavorite>