Metadata

Create or update a type

Create a new type, if it does not exist or update an existing type.

put/v1/metadata/types

Request

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

Request body

namestring required
displayNamestring
descriptionstring required
nameSpacestring required
category'field' | 'entity'
schemastring required
domainsstring[]
extensionobject
dataProductsstring[]

Response

The type

idstring uuid
namestring required
fullyQualifiedNamestring
displayNamestring
descriptionstring required
category'field' | 'entity'
nameSpacestring
schemastring
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
hrefstring uri
provider'system' | 'user' | 'automation'
extensionobject
deletedboolean
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
sourceHashstring

Changes

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