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

Authorizations

​
X-Clinia-API-Key
string
header
required

Path Parameters

​
partitionKey
string
required

Key of the data partition.

Response

A successful response.

​
modules
object
required
​
source
object
required
  • Option 1
  • Option 2
​
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
⌘I