PATCH /api-web/api/dms/objects/{id}

As of Version

product version 2020 Autumn | component version

Request Method PATCH

Response Format JSON

Description

Updates the existing metadata including tags of a DMS object specified by its object ID id with the data passed JSON format in the request body.

The metadata of the modified object is returned in the response body in JSON format.

Response HTTP status codes:

HTTP Status Code	Meaning
200	OK
401	Unauthorized

Response Example

200 OK

{
  "objects": [
    {
      "properties": {
        "system:objectId": {
          "value": "4711-44321-666777888"
        },
        "subject": {
          "value": "This is an information about ..."
        },
        "system:secondaryObjectTypeIds": [
           "appClientsystem:leadingType",
           "tenMytenant:AdministrativeSOT"
       ],
       "system:tags": [
          ["index:resistant", 1],
          ["validate:resistant", 0]
       ]
      }
    }
  ],
  "numItems": 0,
  "hasMoreItems": true,
  "totalNumItems": 0
}