Update directory

Updates directory FOLDER associated with the EHR identified by ehr_id.

The existing latest version_uid of directory FOLDER resource (i.e. the preceding_version_uid) must be specified in the If-Match header.

Path Parameters

ehr_id
Type: string
required

EHR identifier taken from EHR.ehr_id.value.

Headers

If-Match
Type: string
required

Header to make the request conditional. Together with ETag request tag, it helps to prevent simultaneous updates of a resource from overwriting each other ("mid-air collisions"). The format is always an version_uid identifier enclosed by double quotes. The operation will be performed only if the existing latest version_uid of the resource (i.e. the preceding_version_uid) matches this header's value.

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=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 new directory.

A FOLDER resource

archetype_node_id
Type: string
required
name
required
_type
Discriminator
enum
const:
DV_TEXT
required
values
DV_TEXT
value
Type: string
required
encoding
Type: object ·
formatting
Type: string
hyperlink
language
Type: object ·
mappings
Type: array object[] ·
_type
Type: string
archetype_details
Type: object ·
details
_type
Discriminator
Type: string
archetype_node_id
Type: string
required
item
Type: object ·
required
name
required
archetype_details
Type: object ·
feeder_audit
Type: object ·
links
Type: array object[] ·
uid
feeder_audit
Type: object ·
folders
Type: array object[] ·

A FOLDER resource
items
Type: array object[] ·
links
Type: array object[] ·
uid
_type
Discriminator
enum
const:
HIER_OBJECT_ID
required
values
HIER_OBJECT_ID
value
Type: string Format: uuid
required

Responses

application/json
400

400 Bad Request is returned when the request URL or body (if provided) could not be parsed or has invalid content (e.g. invalid ehr_id, or either the body of the request could not be read, or could not be converted to a valid FOLDER object).
404

404 Not Found is returned when an EHR with ehr_id does not exist.

put/ehr/{ehr_id}/directory

curl https://cataniamc.prod.cadasto.com/openehr/v1/ehr/7d44b88c-4199-4bad-97dc-d78268e01398/directory \
  --request PUT \
  --header 'If-Match: "6cb19121-4307-4648-9da0-d62e4d51f19b::cataniamc.prod.cadasto.com::1"' \
  --header 'Content-Type: application/json' \
  --data '{
  "archetype_node_id": "openEHR-EHR-FOLDER.directory.v1",
  "name": {
    "value": "Directory"
  },
  "uid": {
    "_type": "OBJECT_VERSION_ID",
    "value": "8849182c-82ad-4088-a07f-48ead4180515::cataniamc.prod.cadasto.com::1"
  },
  "items": [],
  "folders": []
}'

Show Schema

{
  "archetype_node_id": "openEHR-EHR-FOLDER.directory.v1",
  "name": {
    "value": "Directory"
  },
  "uid": {
    "_type": "OBJECT_VERSION_ID",
    "value": "8849182c-82ad-4088-a07f-48ead4180515::cataniamc.prod.cadasto.com::1"
  },
  "items": [],
  "folders": []
}

200 OK is returned when directory was successfully updated and the updated resource is returned in the body when Prefer header value is return=representation.