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": "d30476e6-0301-4fcb-bb99-d3efd12b42b0",
  "DocumentKey": "5e08e6aa-ea8c-4fd3-b00f-c48a6c665eb0",
  "CreatedOn": "2020-05-28T05:49:22.5613621Z"
}

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>d30476e6-0301-4fcb-bb99-d3efd12b42b0</ContactKey>
  <CreatedOn>2020-05-28T01:49:22.5613621-04:00</CreatedOn>
  <DocumentKey>5e08e6aa-ea8c-4fd3-b00f-c48a6c665eb0</DocumentKey>
</DocumentFavorite>