Skip to main content
GET
/
mdm
/
v1
/
relative-identity-collections
/
{relativeIdentityCollectionKey}
Get a relative identity definition from the mdm
curl --request GET \
  --url https://{workspaceId}.clinia.cloud/mdm/v1/relative-identity-collections/{relativeIdentityCollectionKey} \
  --header 'X-Clinia-API-Key: <api-key>'
{
  "key": "<string>",
  "config": {
    "type": "SEQUENCE",
    "offset": 123
  },
  "differentiators": {},
  "status": "ACTIVE"
}

Authorizations

​
X-Clinia-API-Key
string
header
required

Path Parameters

​
relativeIdentityCollectionKey
string
required

The key of the relative identity definition.

Response

The relative identity definition.

​
key
string
required

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

​
config
object
required

This is used to configure how the relative identities are generated.

​
differentiators
object
required

This is used to configure one or many differentiators properties for a unified collection. The key is the unified collection key and value is the differentiator properties.

​
status
enum<string>
Available options:
ACTIVE,
ARCHIVED