Update PERSON tags

Replaces the full ITEM_TAG list for the target PERSON identified by uid_based_id with the supplied list. Send an empty list to clear all tags.

Path Parameters

uid_based_id
Type: string Format: uuid
required

An identifier in the form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid).

Cadasto exception: unlike the upstream openEHR ITS-REST specification, Cadasto only accepts the versioned_object_uid form on /tags endpoints. Targeting a specific version with an OBJECT_VERSION_ID is not supported — tags are scoped to the versioned object as a whole.

Headers

Prefer

Type: string

RFC 7240 preference header. Multiple tokens may be sent in a single header as a comma-separated list (e.g. Prefer: return=representation, include_item_tags) or as repeated headers. Cadasto recognises the following tokens:

Token	Where it applies	Effect
`return=representation`	write endpoints	Return the full updated resource in the response body.
`return=identifier`	write endpoints	Return only the resource identifier (e.g. the `uid`).
`return=minimal` (default on writes)	write endpoints	Empty response body.
`include_item_tags` (Cadasto extension)	read endpoints, and write endpoints when the request does not already carry an `openehr-item-tag` header	Emit the `openehr-item-tag` response header with the current tags. On writes that ship `openehr-item-tag` in the request, the token is implied — the response always echoes the tags. Omitted by default on reads. See the ITEM_TAG guide for details.

The Preference-Applied response header echoes the tokens the server actually honoured (return=, plus include_item_tags / resolve_refs when applied).

Body

required

application/json

The full new ITEM_TAG list for the target.

Type: array object[] ·

Responses

application/json
204

204 No Content is returned when the tag list was successfully replaced and the Prefer header is missing or set to return=minimal.
application/json
404

404 Not Found is returned when, based on the request parameters, the server did not find a current representation of a target resource, or is not willing to disclose that one exists.

put/demographic/person/{uid_based_id}/tags

curl https://cataniamc.prod.cadasto.com/v1/demographic/person/123e4567-e89b-12d3-a456-426614174000/tags \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "key": "",
    "value": "",
    "target_path": ""
  }
]'

Show Schema

[
  {
    "key": "string",
    "value": "string",
    "target_path": "string",
    "target": {
      "id": {
        "_type": "OBJECT_VERSION_ID",
        "value": "fb458d9c-1323-42bc-b7f8-787f3660a0b5::cataniamc.prod.cadasto.com::1"
      },
      "namespace": "local",
      "type": "COMPOSITION"
    },
    "owner_id": "[Circular]"
  }
]

200 OK is returned with the list of ITEM_TAG resources associated with the target PERSON.