Bulk create, upsert, or delete resources

Authorizations

X-Clinia-API-Key

string

header

required

Path Parameters

sourceKey

string

required

The source key.

Body

application/json

The request body should contain a list of resources to create, upsert, or delete. Operations of different types (e.g., "CREATE", "UPSERT") can be mixed and will be processed in the order they are provided.

operations

object[]

required

Option 1
Option 2
Option 3

Show child attributes

operations.action

enum<string>

required

The action to perform.

Available options:

CREATE,

UPSERT,

DELETE,

UPDATE

operations.create

object

required

The resource to create.

Show child attributes

operations.create.type

string

required

The type of resource to create.

operations.create.data

object

required

Dynamic data attributes, based on the resource type.

operations.create.id

string

Id of the resource to create (optional). When not provided or equal to the special @rootId token, the id will be generated. When provided and not equal to @rootId token, id must follow pattern: ^[a-zA-Z0-9-][\w-]{1,92}$.

Note:

The @rootId token can be used in any properties of type reference and, when provided, will be replaced by the actual id of the created resource.

operations.create.meta

object

Show child attributes

operations.create.meta.createdAt

string<date-time>

Instant of creation of the resource.

operations.create.meta.identifier

object[]

Identifiers of the resource. Note: Combination of source, value and use must be unique.

Show child attributes

operations.create.meta.identifier.id

string

Unique id for the property within a resource (for internal references). This may be any string value that does not contain spaces.

operations.create.meta.identifier.system

string

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

operations.create.meta.identifier.value

string

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

operations.create.meta.identifier.use

string

The purpose of this identifier.

operations.create.meta.identifier.period

object

Time period when identifier was/is in use.

Show child attributes

operations.create.meta.identifier.period.id

string

Unique id for the property within a resource (for internal references). This may be any string value that does not contain spaces.

operations.create.meta.identifier.period.start

string

The start of the period. The boundary is inclusive.

operations.create.meta.identifier.period.end

string

The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

operations.create.meta.updatedAt

string<date-time>

Last update of the resource.

operations.create.contained

object

Resources contained in this top-level resource. Contained resources exists only within the context of this top-level resource.

Show child attributes

operations.create.contained.{key}

object[]

Show child attributes

operations.create.contained.{key}.type

string

required

Type of the resource.

operations.create.contained.{key}.data

The dynamic attributes based on the resource type · object

required

operations.create.contained.{key}.id

string

When provided, the id must follow the semantic of contained resource ids (e.g. clinic/1/healthService/1). The contained ids can be provided even if the top-level id is not provided (or equal to @rootId). In those cases, use the special @rootId token to refer to the top-level id (e.g. clinic/@rootId/healthService/1).

If not provided, the id of the given contained will be generated sequentially per contained key, starting at 1. For instance, if there are 3 contained for the key healthService, they will be generated in order as such: [clinic/1/healthService/1, clinic/1/healthService/2, clinic/1/healthService/3]

When some contained ids are provided and some are not, the generated ids will still be sequential starting from 1, ignoring collisions with provided ids. For instance, if you insert 5 contained resources under the same key healthService and only provide ids like such: [clinic/1/healthService/3, , clinic/1/healthService/5, clinic/1/healthService/100], the outcome will be [clinic/1/healthService/3, clinic/1/healthService/1, clinic/1/healthService/2, clinic/1/healthService/5, clinic/1/healthService/100].

operations.create.contained.{key}.meta

object

Show child attributes

operations.create.contained.{key}.meta.createdAt

string<date-time>

Instant of creation of the resource.

operations.create.contained.{key}.meta.identifier

object[]

Identifiers of the resource. Note: Combination of source, value and use must be unique.

Show child attributes

operations.create.contained.{key}.meta.identifier.id

string

Unique id for the property within a resource (for internal references). This may be any string value that does not contain spaces.

operations.create.contained.{key}.meta.identifier.system

string

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

operations.create.contained.{key}.meta.identifier.value

string

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

operations.create.contained.{key}.meta.identifier.use

string

The purpose of this identifier.

operations.create.contained.{key}.meta.identifier.period

object

Time period when identifier was/is in use.

Show child attributes

operations.create.contained.{key}.meta.identifier.period.id

string

Unique id for the property within a resource (for internal references). This may be any string value that does not contain spaces.

operations.create.contained.{key}.meta.identifier.period.start

string

The start of the period. The boundary is inclusive.

operations.create.contained.{key}.meta.identifier.period.end

string

operations.create.contained.{key}.meta.updatedAt

string<date-time>

Last update of the resource.

Response

The bulk operation is valid and accepted with a status 'ACCEPTED'.

Response when a task has been accepted for asynchronous processing. The task will be executed in the background.

taskId

string

required

The task identifier. Used to track an async task in the system. Use the task ID to poll for completion status. The taskId holds different prefix to represent different tasks.

oneOf task: s_<id>.
bulk task: bk_<id> (deprecated: <id> only).
bundle task: bd_<id> (deprecated: <id> only).
purge task: pg_<id> (deprecated: purge:<id>).

status

enum<string>

required

Status of the task submission.

ACCEPTED: The task has been accepted for asynchronous processing. The task will be executed in the background.
PERSISTED: The task has been executed synchronously and the results are immediately persisted.

Available options:

ACCEPTED,

PERSISTED

bulkId

string

required

The task identifier. This is deprecated, please use the taskId field instead.

AI Endpoints

Data Catalog Endpoints

Data Partition Endpoints

MDM Endpoints

Registry Endpoints

Terminology Endpoints

Bulk create, upsert, or delete resources

Authorizations

Path Parameters

Body

Response