Get a specific history item

Authorizations

X-Clinia-API-Key

string

header

required

Path Parameters

sourceKey

string

required

The source key.

collectionType

enum<string>

required

The type of the collection.

Available options:

resources,

relationships,

objects

collectionKey

string

required

The key of the collection.

itemId

string

required

The id of the item.

operationId

string

required

The unique ID of the operation entry.

Query Parameters

withPayload

boolean

default:false

If true, the full entity payload related to the operationId will be included in the response.

Response

The specific version history item.

Option 1
Option 2
Option 3

A version history item that includes the full data payload of the entity at that point in time.

string

required

The unique identifier of the resource or relationship.

type

string

required

The collection type of the entity.

targetType

enum<string>

required

Available options:

resources,

relationships,

objects

operationId

string

required

The unique identifier of the operation.

taskId

string

required

The identifier of the task that processed this operation.

timestamp

string<date-time>

required

The exact time the operation was applied.

action

enum<string>

required

The action to perform.

Available options:

CREATE,

UPSERT,

DELETE,

UPDATE

userInfo

object

required

Information about the user or service that performed the operation.

Show child attributes

userInfo.id

string

required

userInfo.email

string

required

payload

object

required

Show child attributes

payload.id

string

required

Id of the resource.

payload.type

string

required

Type of the resource.

payload.data

object

required

Dynamic data attributes, based on the resource type.

payload.meta

object

Show child attributes

payload.meta.createdAt

string<date-time>

Instant of creation of the resource.

payload.meta.identifier

object[]

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

Show child attributes

payload.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.

payload.meta.identifier.system

string

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

payload.meta.identifier.value

string

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

payload.meta.identifier.use

string

The purpose of this identifier.

payload.meta.identifier.period

object

Time period when identifier was/is in use.

Show child attributes

payload.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.

payload.meta.identifier.period.start

string

The start of the period. The boundary is inclusive.

payload.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.

payload.meta.source

string

The source of the resource.

payload.meta.updatedAt

string<date-time>

Last update of the resource.

payload.contained

object

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

Show child attributes

payload.contained.{key}

object[]

Show child attributes

payload.contained.{key}.id

string

required

payload.contained.{key}.type

string

required

Type of the resource.

payload.contained.{key}.data

The dynamic attributes based on the resource type · object

required

payload.contained.{key}.meta

object

Show child attributes

payload.contained.{key}.meta.createdAt

string<date-time>

Instant of creation of the resource.

payload.contained.{key}.meta.identifier

object[]

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

Show child attributes

payload.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.

payload.contained.{key}.meta.identifier.system

string

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

payload.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.

payload.contained.{key}.meta.identifier.use

string

The purpose of this identifier.

payload.contained.{key}.meta.identifier.period

object

Time period when identifier was/is in use.

Show child attributes

payload.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.

payload.contained.{key}.meta.identifier.period.start

string

The start of the period. The boundary is inclusive.

payload.contained.{key}.meta.identifier.period.end

string

payload.contained.{key}.meta.source

string

The source of the resource.

payload.contained.{key}.meta.updatedAt

string<date-time>

Last update of the resource.

AI Endpoints

Data Catalog Endpoints

Data Partition Endpoints

MDM Endpoints

Registry Endpoints

Terminology Endpoints

Get a specific history item

Authorizations

Path Parameters

Query Parameters

Response