POST /api/dms/objects/{objectId}/tags/{name}/state/{state}

To add a new tag to a DMS object, send the request with the ID of the DMS object as objectId including the info of the tag's name and state. The method throws an exception, if the committed tag name already exists.

Furthermore, there is the possibility to set a traceid by means of the HTTP header: X-B3-TraceId. If not specified, a random traceid will be set.

Any successful tag creation will be added to the audit trail.

Tags are independent of an object's version and thus are always available at the current version. For version-specific information, metadata provide the suitable options.

As of 2022 Autumn, the optional query parameter waitForSearchConsistency can be added to the request URL. If not specified, the default value true is used.

/api/dms/objects/insert-objectid-here/tags/tag1/state/100

The result is a JSON structure containing the 'value' entries of the created tag: name, state, creationDate and traceid.

{
  "objects": [
    {
      "properties": {
        "system:tags": {
          "value": [
            [
              "tag1",
              100,
              "2020-02-20T02:20:20.220Z",
              "1234567887654321"
            ]
          ]
        }
      }
    }
  ]
}