POST api/v1.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": "2451f72b-016f-4286-b2f0-835cc805095c",
  "DocumentKey": "3c34e396-9b98-4a90-85d8-e04b949290d9",
  "CreatedOn": "2024-05-30T07:09:40.4934059Z"
}

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>2451f72b-016f-4286-b2f0-835cc805095c</ContactKey>
  <CreatedOn>2024-05-30T03:09:40.4934059-04:00</CreatedOn>
  <DocumentKey>3c34e396-9b98-4a90-85d8-e04b949290d9</DocumentKey>
</DocumentFavorite>