POST /api/dms/objects/tags/{name}/state/{state}?query=<SQL>
As of Version | product version 2020 Summer | component version 2020 Summer |
---|---|
Request Method | POST |
Response Format | JSON |
Required Permission | action |
Description | Add or update the tag with the Optionally, there is the possibility to set a If an object was found to match the query and is processable, the following behavior is triggered:
Internally, the endpoint retrieves a result list of up to 40 objects matching the specified query. The tag update/addition is applied to the first match. However, if the tag update/addition is not possible, it will be applied to the next result. In case there is no matching object left, an empty list will be returned. Especially other calls of the Tags are independent of an object's version and thus are always available for the current version. For version-specific information, metadata provide the suitable options. As of 2022 Autumn, the optional query parameter |
Request Example | POST The query searches for objects of type |
Result Example | The return is a JSON structure containing the information on existing tags and metadata dedicated to the modified object. { "objects": [ { "properties": { "system:objectId": { "value": "insert-objectid-here" }, "system:tags": { "value": [ [ "tag1", 100, "2020-02-20T02:22:20.220Z", "1234567887654321" ] ] }, "system:baseTypeId": { "value": "system:document" }, "system:objectTypeId": { "value": "document" }, "system:secondaryObjectTypeIds": { "value": [ "system:rmDestructionRetention" ] }, "system:createdBy": { "value": "this-id-indicates-the-user" }, "system:creationDate": { "value": "2020-02-20T02:02:20.220Z" }, "system:lastModifiedBy": { "value": "this-id-indicates-another-user" }, "system:lastModificationDate": { "value": "2020-02-20T02:20:22.220Z" }, "system:versionNumber": { "value": 1 }, "system:tenant": { "value": "default" }, "system:traceId": { "value": "abcdef123456" }, "Name": { "value": "Email" }, "date": { "value": "2002-02-20T02:20:00.220Z" } }, "contentStreams": [ { "contentStreamId": "0B469DD0-AA6F-11EA-A7FE-DD3E0B230EEB", "archivePath": "default/DOCUMENT/B4/69/D/", "length": 200001, "mimeType": "application/pdf", "fileName": "exchange-doku-jar.pdf", "digest": "334A9337CFEFC4B1D25C9CC0289205B3133DA4CDE8086C6A9D2FF61CC3205F55", "repositoryId": "repo252" } ] } ] } |