POST api/v2.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": "20dc8dad-da91-474b-a253-3e0a1aa649b8", "DocumentKey": "ac9962ac-50fd-4d0b-88fa-4efdf28b5588", "CreatedOn": "2024-12-26T10:37:00.5972906Z" }
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>20dc8dad-da91-474b-a253-3e0a1aa649b8</ContactKey> <CreatedOn>2024-12-26T05:37:00.5972906-05:00</CreatedOn> <DocumentKey>ac9962ac-50fd-4d0b-88fa-4efdf28b5588</DocumentKey> </DocumentFavorite>