[POST] /favourites

[POST] /favourites

Description

Add dms objects to the favourites portfolio.

Request
Method

POST

Request optional
Query Parameter

  • minimalResponse (Boolean): The response contain on success only a HTTP/204 and not the updated list of favourites. This saves the time of loading the favourites after insert and make the call faster.

Response
Format

JSON

Minimum Version

6.9.0

Request
Example

/api/dms/objects/native/favourites

{ "objects": [{ "properties": { "system:objectId": { "value": "11816" }, "system:objectTypeId": { "value": "26" } } },{ "properties": { "system:objectId": { "value": "11817" }, "system:objectTypeId": { "value": "<localName>" } } },{ "properties": { "system:objectId": { "value": "11818" } } }] }

Result
Example

{ "objects": [{ "properties": { "system:objectId": { "value": "11816" }, "system:objectTypeId": { "value": "262188" }, "system:baseTypeId": { "value": "document" } } },{ "properties": { "system:objectId": { "value": "11817" }, "system:objectTypeId": { "value": "262188" }, "system:baseTypeId": { "value": "document" } },{ "properties": { "system:objectId": { "value": "11818" }, "system:objectTypeId": { "value": "262188" }, "system:baseTypeId": { "value": "document" } }], "numItems": 3, "hasMoreItems": false, "totalNumItems": 3 }