POST api/v1.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": "6c6a34bf-1d2b-4987-aa43-ed094ff124d8", "DocumentKey": "9d878692-32c2-409b-8bf0-c8210010b1e5", "CreatedOn": "2024-09-08T02:57:25.1074697Z" }
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>6c6a34bf-1d2b-4987-aa43-ed094ff124d8</ContactKey> <CreatedOn>2024-09-07T22:57:25.1074697-04:00</CreatedOn> <DocumentKey>9d878692-32c2-409b-8bf0-c8210010b1e5</DocumentKey> </DocumentFavorite>