Skip to main content
PUT
/
catalog
/
v1
/
partitions
/
{partitionKey}
Create a data partition
curl --request PUT \
  --url https://{workspaceId}.clinia.cloud/catalog/v1/partitions/{partitionKey} \
  --header 'Content-Type: application/json' \
  --header 'X-Clinia-API-Key: <api-key>' \
  --data '
{
  "modules": {
    "search": "STANDARD"
  },
  "source": {
    "type": "MDM",
    "sources": [
      "<string>"
    ],
    "collections": [
      {
        "properties": {},
        "mappings": [
          {
            "source": "<string>",
            "type": "<string>",
            "propertyMappings": {}
          }
        ],
        "key": "<string>",
        "traversedProperties": [
          "<string>"
        ],
        "reconciliationRules": {
          "type": "SYSTEM",
          "rules": {}
        },
        "contained": {}
      }
    ],
    "relationships": [
      {
        "from": {
          "profileKey": "<string>",
          "includeKey": "<string>"
        },
        "to": {
          "profileKey": "<string>",
          "includeKey": "<string>"
        },
        "relationshipType": "<string>",
        "properties": {},
        "mappings": [
          {
            "source": "<string>",
            "type": "<string>",
            "propertyMappings": {}
          }
        ],
        "reconciliationRules": {
          "type": "SYSTEM",
          "rules": {}
        }
      }
    ]
  }
}
'
{
  "modules": {
    "search": "STANDARD"
  },
  "source": {
    "type": "MDM",
    "sources": [
      "<string>"
    ],
    "collections": [
      {
        "properties": {},
        "mappings": [
          {
            "source": "<string>",
            "type": "<string>",
            "propertyMappings": {}
          }
        ],
        "key": "<string>",
        "traversedProperties": [
          "<string>"
        ],
        "reconciliationRules": {
          "type": "SYSTEM",
          "rules": {}
        },
        "contained": {}
      }
    ],
    "relationships": [
      {
        "from": {
          "profileKey": "<string>",
          "includeKey": "<string>"
        },
        "to": {
          "profileKey": "<string>",
          "includeKey": "<string>"
        },
        "relationshipType": "<string>",
        "properties": {},
        "mappings": [
          {
            "source": "<string>",
            "type": "<string>",
            "propertyMappings": {}
          }
        ],
        "reconciliationRules": {
          "type": "SYSTEM",
          "rules": {}
        }
      }
    ]
  },
  "key": "<string>",
  "status": "STATUS_READY"
}

Authorizations

​
X-Clinia-API-Key
string
header
required

Path Parameters

​
partitionKey
string
required

Key of the data partition it must follow pattern: ^[a-zA-Z0-9-][\w-]{0,61}$.

Query Parameters

​
stage
boolean

If true, the partition will be created as a staged partition. Staged partitions are mutable and can be modified.

If false, the partition will be created directly. This is the default behaviour and will make the data partition are immutable.

As of now, staged partitions are not fully supported and it is recommended to directly create ready partitions.

Body

application/json
​
modules
object
required
​
source
object
required

Response

A successful response when the data partition was created.

​
modules
object
required
​
source
object
required
​
key
string
​
status
enum<string>

The status of the data partition.

  • STATUS_STALE: The data partition still exists, but the underlying data source was deleted. You can still read the data partition configuration, but you can no longer query it.
  • STATUS_STAGE: The data partition configuration is mutable. You can still query it as normal.
  • STATUS_READY: The data partition configuration is immutable.
Available options:
STATUS_READY,
STATUS_STAGE,
STATUS_STALE