Skip to main content
GET
/
sources
/
{sourceKey}
/
v1
/
history
/
{collectionType}
/
{collectionKey}
/
{itemId}
/
operations
Get the history for a record or relationship
curl --request GET \
  --url https://{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/history/{collectionType}/{collectionKey}/{itemId}/operations \
  --header 'X-Clinia-API-Key: <api-key>'
[
  {
    "id": "<string>",
    "type": "<string>",
    "targetType": "resources",
    "operationId": "<string>",
    "taskId": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "action": "CREATE",
    "userInfo": {
      "id": "<string>",
      "email": "<string>"
    }
  }
]

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.

Query Parameters

​
perPage
integer<int32>
default:20

The number of items to return per page.

​
page
integer<int32>
default:1

The page number to retrieve.

​
from
string<date-time>

The start of the date range filter (ISO 8601 format). The default value is the beginning of time.

​
to
string<date-time>

The end of the date range filter (ISO 8601 format). The default value is now.

Response

A list of version history items for the entity.

​
id
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.