POST api/v2.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": "a9828e8e-ec0f-40f5-aba3-c8163ee06431",
  "DocumentKey": "3edefe54-c850-4868-ab25-a4b0ac6af0da",
  "CreatedOn": "2022-01-26T05:57:40.0051351Z"
}

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>a9828e8e-ec0f-40f5-aba3-c8163ee06431</ContactKey>
  <CreatedOn>2022-01-26T00:57:40.0051351-05:00</CreatedOn>
  <DocumentKey>3edefe54-c850-4868-ab25-a4b0ac6af0da</DocumentKey>
</DocumentFavorite>