Domains

Create or update a domain

Create a domain. if it does not exist. If a domain already exists, update the domain.

put/v1/domains

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/domains
  • Auth: HTTP bearer

Request body

domainType'Source-aligned' | 'Consumer-aligned' | 'Aggregate' required
namestring required
fullyQualifiedNamestring
displayNamestring
descriptionstring required
parentstring
expertsstring[]
extensionobject
dataProductsstring[]
domainsstring[]

Response

The domain

idstring uuid required
domainType'Source-aligned' | 'Consumer-aligned' | 'Aggregate' required
namestring required
fullyQualifiedNamestring
displayNamestring
descriptionstring required
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
hrefstring uri
childrenCountinteger
extensionobject
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
provider'system' | 'user' | 'automation'
deletedboolean
sourceHashstring

Changes

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