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": "88e47a37-5eec-4c2a-95e7-6cbb5f3851cf", "DocumentKey": "2711f5e2-cbe7-4e0b-910d-c2406487ab47", "CreatedOn": "2021-01-19T15:35:52.2321311Z" }
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>88e47a37-5eec-4c2a-95e7-6cbb5f3851cf</ContactKey> <CreatedOn>2021-01-19T10:35:52.2321311-05:00</CreatedOn> <DocumentKey>2711f5e2-cbe7-4e0b-910d-c2406487ab47</DocumentKey> </DocumentFavorite>