Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
hiddentrue
idDONE

Product Version
Report Note
Assignee

Resources & Remarks

Modification History

NameDateProduct VersionAction
Antje18 MAY 20212021 SummerPage created.
Antje16 DEC 20212022 SpringTags are NOT part of the metadata....


...

As of Version

product version 2020 Autumn | component version 

Request MethodPATCH
Response FormatJSON
Description


Excerpt

Updates the metadata and/or tags of an existing DMS object specified by its object ID id with the data passed JSON format in the request body.


Internally, the core API endpoint PATCH /api/dms/objects/{objectId} is called. Thus, only those properties that are part of the request body are changed. Properties that are missing in the request body are not changed by the update.

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

Response HTTP status codes:

HTTP Status CodeMeaning
200 OK
401 Unauthorized


Response Example

200 OK

Code Block
{
  "appMyapp:SigRequester": "d619d554-542a-4943-b192-b5c4e1ee021c",
  "appMyapp:Signers": [
    {
      "SignerName": "Martin Smith",
      "SignerEmail": "smith@web.de",
      "SignOrder": 1
    },
    {
      "SignerName": "Andreas Blacksmith",
      "SignerEmail": Ruiz@mail.com,
      "SignOrder": 2
    }
  ],
  "system:secondaryObjectTypeIds": [
    "appClientsystem:leadingType",
    "tenMytenant:Documentclass",
    "appMyapp:SignaturesSOT"
  ]
}

The custom property property appMyapp:SigRequester has is of cardinality single so has "single", which means that it has only one value.

The In this example, the custom property appMyapp:Signers is of type table with the column two rows and the following columns: SignerName, SignerEmail, and SignOrder. and two rows in this example.

Setting the system property system:secondaryObjectTypeIds adds or removes Secondary Object Types secondary object types like appMyapp:SignaturesSOT to the instance or removes them from it.