Profiles

Create or update a Profile in the registry

Updating a profile is currently not supported and will return a 501.

put/sources/{sourceKey}/v1/profiles/{profileKey}

Request

  • Base URL
    https://.clinia.cloud
  • URL
    https://.clinia.cloud/sources/{sourceKey}/v1/profiles/{profileKey}
  • Auth
    API key in header X-Clinia-API-Key

Path parameters

sourceKeystring required

The key of the source.

profileKeystring required

The key of the profile. It must follow pattern: ^[a-zA-Z0-9-][\w-]{0,61}$.

Request body

type'ROOT' | 'CONTAINED' required
descriptionstring

Description of the profile.

propertiesobject required

Properties of the profile. It must follow pattern: ^[a-zA-Z0-9-][\w-]$.

containedobject

Contained of the profile. It must follow pattern: ^[a-zA-Z0-9-][\w-]$.

Response

The profile was created successfully.

keystring required
type'ROOT' | 'CONTAINED' required
descriptionstring

Description of the profile.

propertiesobject required
containedobject

Changes

No recorded changes to this operation across all 1 revision of this API.