Page Properties | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Resources & Remarks Modification History
|
As of Version | product version 2020 Autumn | component version | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request Method | PATCH | |||||||||||||
Response Format | JSON | |||||||||||||
Description |
The role YUUVIS_TENANT_ADMIN is requiredInternally, 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:
| Request Example |
Code Block |
---|
{} |
200 OK
Code Block |
---|
{ "appMyapp:SigRequester": "d619d554-542a-4943-b192-b5c4e1ee021c", "objectsappMyapp:Signers": [ { "propertiesSignerName": { "Martin Smith", "system:objectIdSignerEmail": { "smith@web.de", "valueSignOrder": "4711-44321-666777888"1 }, }, { "subjectSignerName": { "Andreas Blacksmith", "valueSignerEmail": "Sie sind der Doc, Doc."Ruiz@mail.com, "SignOrder": 2 } ], }"system:secondaryObjectTypeIds": [ }"appClientsystem:leadingType", ], "numItems": 0,tenMytenant:Documentclass", "hasMoreItemsappMyapp:SignaturesSOT": true, ] "totalNumItems": 0 }} |
The custom property appMyapp:SigRequester
is of cardinality "single", which means that it has only one value.
In this example, the custom property appMyapp:Signers
is of type table with two rows and the following columns: SignerName
, SignerEmail
, and SignOrder
.
Setting the system property system:secondaryObjectTypeIds
adds secondary object types like appMyapp:SignaturesSOT
to the instance or removes them from it.