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": "a559f6f9-2058-4c41-acf7-591468a907d9", "DocumentKey": "daaa1968-265c-413e-adf3-cf2ecf4e5d9b", "CreatedOn": "2025-05-12T23:37:35.3687426Z" }
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>a559f6f9-2058-4c41-acf7-591468a907d9</ContactKey> <CreatedOn>2025-05-12T19:37:35.3687426-04:00</CreatedOn> <DocumentKey>daaa1968-265c-413e-adf3-cf2ecf4e5d9b</DocumentKey> </DocumentFavorite>