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": "a800097d-0625-4cc4-8f4e-c1ea9dbbb933",
  "DocumentKey": "4b9dac96-71af-4148-a473-339204e8f166",
  "CreatedOn": "2021-09-26T16:36:31.7641265Z"
}

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>a800097d-0625-4cc4-8f4e-c1ea9dbbb933</ContactKey>
  <CreatedOn>2021-09-26T12:36:31.7641265-04:00</CreatedOn>
  <DocumentKey>4b9dac96-71af-4148-a473-339204e8f166</DocumentKey>
</DocumentFavorite>