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": "14a2a3f8-b447-4b09-a5cd-b4290fb1a772", "DocumentKey": "537ef92a-e679-4bb7-acc7-44b1b1d9e5a3", "CreatedOn": "2025-05-09T22:40:16.585745Z" }
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>14a2a3f8-b447-4b09-a5cd-b4290fb1a772</ContactKey> <CreatedOn>2025-05-09T18:40:16.585745-04:00</CreatedOn> <DocumentKey>537ef92a-e679-4bb7-acc7-44b1b1d9e5a3</DocumentKey> </DocumentFavorite>