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": "952497ef-8d32-413d-bb65-242786c88ff5",
  "DocumentKey": "d02950f0-e3be-4fc5-a101-70e5bc9af69e",
  "CreatedOn": "2020-02-25T02:31:58.6375505Z"
}

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>952497ef-8d32-413d-bb65-242786c88ff5</ContactKey>
  <CreatedOn>2020-02-24T21:31:58.6375505-05:00</CreatedOn>
  <DocumentKey>d02950f0-e3be-4fc5-a101-70e5bc9af69e</DocumentKey>
</DocumentFavorite>