POST api/v1.0/ResourceLibrary/AddToFavorites?documentKey={documentKey}
Add the specified Document to the Authenticated User's Favorite List.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
documentKey |
DocumentKey of a Document. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
DocumentFavoriteName | Description | Type | Additional information |
---|---|---|---|
ContactKey | globally unique identifier |
None. |
|
DocumentKey | globally unique identifier |
None. |
|
CreatedOn | date |
None. |
Response Formats
application/json, text/json
Sample:
{ "ContactKey": "a6078da9-e4f3-4212-a99c-2a6092357c29", "DocumentKey": "7368f5c3-c548-4c0b-8d5a-637f74ef9ee8", "CreatedOn": "2024-03-28T11:16:11.7817283Z" }
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>a6078da9-e4f3-4212-a99c-2a6092357c29</ContactKey> <CreatedOn>2024-03-28T07:16:11.7817283-04:00</CreatedOn> <DocumentKey>7368f5c3-c548-4c0b-8d5a-637f74ef9ee8</DocumentKey> </DocumentFavorite>