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": "03d72723-3f6c-421e-8b18-3519c18d5982", "DocumentKey": "68b63f78-008c-418a-8022-d5990c46ea5e", "CreatedOn": "2024-07-27T07:02:40.8296139Z" }
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>03d72723-3f6c-421e-8b18-3519c18d5982</ContactKey> <CreatedOn>2024-07-27T03:02:40.8296139-04:00</CreatedOn> <DocumentKey>68b63f78-008c-418a-8022-d5990c46ea5e</DocumentKey> </DocumentFavorite>