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": "088a7288-efc2-48e0-b99d-deae98b0f309",
  "DocumentKey": "8bf506cf-2618-4606-811c-827c71ca7cde",
  "CreatedOn": "2019-07-21T08:27:22.3848386Z"
}

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>088a7288-efc2-48e0-b99d-deae98b0f309</ContactKey>
  <CreatedOn>2019-07-21T04:27:22.3848386-04:00</CreatedOn>
  <DocumentKey>8bf506cf-2618-4606-811c-827c71ca7cde</DocumentKey>
</DocumentFavorite>