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": "c20cf063-3584-4fb8-bc42-3f15a0abdfba",
  "DocumentKey": "7c26da71-8997-486a-94b9-5d877c2b4e51",
  "CreatedOn": "2019-05-25T18:53:54.099855Z"
}

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>c20cf063-3584-4fb8-bc42-3f15a0abdfba</ContactKey>
  <CreatedOn>2019-05-25T14:53:54.099855-04:00</CreatedOn>
  <DocumentKey>7c26da71-8997-486a-94b9-5d877c2b4e51</DocumentKey>
</DocumentFavorite>