Data Contracts

Get the effective data contract for an entity

Get the effective data contract for an entity, including inherited contract properties from its data product if applicable.

get/v1/dataContracts/entity

Request

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

Query parameters

entityIdstring

ID of the related Entity

entityTypestring
Example:table

Entity Type to get the data contract for

fieldsstring
Example:owners,reviewers,extension

Fields requested in the returned resource

Response

The effective data contract (may include inherited properties)

idstring uuid required
namestring required
displayNamestring
fullyQualifiedNamestring
descriptionstring
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
createdAtinteger
createdBystring
hrefstring uri
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
effectiveFromstring date-time
effectiveUntilstring date-time
deletedboolean
sourceUrlstring
extensionobject
inheritedboolean
provider'system' | 'user' | 'automation'
sourceHashstring

Changes

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