Skip to main content
PUT
/
sources
/
{sourceKey}
/
v1
/
resources
/
{resourceType}
/
{id}
/
{containKey}
/
{containedResourceId}
Upsert a contained resource in the registry
curl --request PUT \
  --url https://{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/resources/{resourceType}/{id}/{containKey}/{containedResourceId} \
  --header 'Content-Type: application/json' \
  --header 'X-Clinia-API-Key: <api-key>' \
  --data '{
  "type": "<string>",
  "data": {},
  "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.

​
id
string
required

Id of the resource.

​
containKey
string
required

Key of the contained resource. This is the key of the profile that defines the contained resource type.

​
containedResourceId
string
required

Id of the contained resource.

Body

application/json
​
type
string
required

type for the contained resource.

​
data
object
required

Dynamic data attributes, based on the resource type.

​
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 contained resource was replaced with a status 'PERSISTED'. The root resource is returned.

  • 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