Mark Entity as Favorite (for Current User)
Marks an entity as favorite for the current user.
Marks an entity as favorite for the current user. Further, it allows you to mention
a favorite flag in search request:
filter=equals(favoriteFor,
'userName'). Or, as another example, filter=in(favoriteFor,
'user1Name,user2Name,...').
Request
PUT {TenantURL}/{entityURI1}/_markFavorite| Parameter | Required | Details | |
|---|---|---|---|
| Headers | Authorization |
Yes | Information about authentication access token in format "Bearer
<accessToken>" (see details in Authentication API).
|
Response
Returns an entity in updated state (with the isFavorite flag).
Request
PUT {TenantURL}/entities/031WTej/_markFavorite
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512Response
[{
"index": 0,
"object": {
"URI": "entities/031WTej",
"type": "configuration/entityTypes/Individual",
"createdBy": "admin",
"createdTime": 1363953910550,
"updatedBy": "admin",
"updatedTime": 1363954004898,
"startDate": 170802000000,
"roles": ["configuration/roles/Client"],
"isFavorite": true,
"attributes": {} },
"successful": true
}]