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": "6a8d9192-7459-490a-8fef-2223a310cd0b", "DocumentKey": "a0d0b05a-1745-477f-a664-3978cb089038", "CreatedOn": "2024-04-24T09:08:20.3200751Z" }
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>6a8d9192-7459-490a-8fef-2223a310cd0b</ContactKey> <CreatedOn>2024-04-24T05:08:20.3200751-04:00</CreatedOn> <DocumentKey>a0d0b05a-1745-477f-a664-3978cb089038</DocumentKey> </DocumentFavorite>