Metadata

Create a custom property definition

Create a new custom property definition that can be applied to entities. This creates a property template using existing OpenMetadata data types (String, Integer, Date, Enum, etc.). The created property can then be used to extend metadata for data assets like tables, dashboards, and pipelines. Note: This does not create new data types - only custom property definitions.

post/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 custom property definition

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.