Skip to main content
POST
/
sources
/
{sourceKey}
/
v1
/
objects
/
{collectionKey}
Create an object
curl --request POST \
  --url https://{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/objects/{collectionKey} \
  --header 'Content-Type: application/json' \
  --header 'X-Clinia-API-Key: <api-key>' \
  --data '{}'
{
  "taskId": "<string>",
  "status": "ACCEPTED",
  "object": {
    "id": "<string>",
    "type": "<string>",
    "meta": {
      "createdAt": "2023-11-07T05:31:56Z",
      "identifier": [
        {
          "id": "<string>",
          "system": "<string>",
          "value": "<string>",
          "use": "<string>",
          "period": {
            "id": "<string>",
            "start": "<string>",
            "end": "<string>"
          }
        }
      ],
      "source": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "data": {},
    "fileMeta": {
      "originalName": "<string>",
      "mimeType": "<string>",
      "size": 1,
      "key": "<string>"
    }
  }
}

Authorizations

​
X-Clinia-API-Key
string
header
required

Path Parameters

​
sourceKey
string
required

The key of the data source where you want to create the object.

​
collectionKey
string
required

The key of the object collection.

Body

Placeholder to prevent client generation failure, do not use.

Response

A successful response when the create object task is accepted with a status 'ACCEPTED'.

  • Option 1
  • Option 2

Response when a task has been executed synchronously and the results are immediately persisted.

​
object
object
required

An object is a resource representing a binary file stored in the repository.

​
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
⌘I