Skip to main content
POST
/
sources
/
{sourceKey}
/
v1
/
resources
/
{resourceType}
Create a resource in the registry
curl --request POST \
  --url https://{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/resources/{resourceType} \
  --header 'Content-Type: application/json' \
  --header 'X-Clinia-API-Key: <api-key>' \
  --data '{
  "id": "<string>",
  "data": {},
  "meta": {
    "createdAt": "2023-11-07T05:31:56Z",
    "identifier": [
      {
        "id": "<string>",
        "system": "<string>",
        "value": "<string>",
        "use": "<string>",
        "period": {
          "id": "<any>",
          "start": "<any>",
          "end": "<any>"
        }
      }
    ],
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "contained": {}
}'
{
  "taskId": "<string>",
  "status": "ACCEPTED",
  "resource": {
    "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": {},
    "contained": {}
  }
}

Authorizations

​
X-Clinia-API-Key
string
header
required

Path Parameters

​
sourceKey
string
required

The key of the source.

​
resourceType
string
required

Type of the resource. Key of the profile.

Body

application/json
​
data
object
required

Dynamic data attributes, based on the resource type.

​
id
string

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

  • @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.
​
meta
object
​
contained
object

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

Response

A successful response when the resource was created.

  • Option 1
  • Option 2

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

​
resource
object
required
​
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