Skip to main content
PUT
/
sources
/
{sourceKey}
/
v1
/
collections
/
{collectionKey}
Create or update a registry collection
curl --request PUT \
  --url https://{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/collections/{collectionKey} \
  --header 'Content-Type: application/json' \
  --header 'X-Clinia-API-Key: <api-key>' \
  --data '{
  "type": "resources",
  "key": "<string>",
  "pipeline": {
    "steps": [
      {
        "type": "SEGMENTER",
        "trigger": {
          "type": "<any>",
          "operator": "<any>"
        },
        "segmenter": {
          "inputProperty": "<any>",
          "propertyKey": "<any>",
          "propertyDescription": "<any>",
          "modelId": "<any>"
        }
      }
    ]
  },
  "profile": {
    "type": "ROOT",
    "description": "<string>",
    "properties": {},
    "contained": {}
  }
}'
{
  "type": "resources",
  "key": "<string>",
  "pipeline": {
    "id": "<string>",
    "steps": [
      {
        "type": "SEGMENTER",
        "trigger": {
          "type": "<any>",
          "operator": "<any>"
        },
        "segmenter": {
          "inputProperty": "<any>",
          "propertyKey": "<any>",
          "propertyDescription": "<any>",
          "modelId": "<any>"
        }
      }
    ]
  },
  "profile": {
    "key": "<string>",
    "type": "ROOT",
    "description": "<string>",
    "properties": {},
    "contained": {}
  }
}

Authorizations

X-Clinia-API-Key
string
header
required

Path Parameters

sourceKey
string
required

The key of the source.

collectionKey
string
required

The key of the collection.

Body

application/json
  • Option 1
  • Option 2
  • Option 3
type
enum<string>
required

The type of the collection.

Available options:
resources,
relationships,
objects
key
string
required

The key of the collection.

profile
object
required

The profile of the collection.

pipeline
object

The ingestion pipeline of the collection.

Response

A successful response when the collection was created.

  • Option 1
  • Option 2
  • Option 3
type
enum<string>
required

The type of the collection.

Available options:
resources,
relationships,
objects
key
string
required

The key of the collection.

profile
object
required

The profile of the collection.

pipeline
object

The ingestion pipeline of the collection.

I