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": "2138abbd-8c87-41c5-8107-3f46611ee39d",
  "DocumentKey": "00fd6b87-6ff1-40c5-972a-bc16a4588a43",
  "CreatedOn": "2021-04-21T01:14:22.0459073Z"
}

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>2138abbd-8c87-41c5-8107-3f46611ee39d</ContactKey>
  <CreatedOn>2021-04-20T21:14:22.0459073-04:00</CreatedOn>
  <DocumentKey>00fd6b87-6ff1-40c5-972a-bc16a4588a43</DocumentKey>
</DocumentFavorite>