Data Contracts

Export data contract to ODCS format by FQN

Export a data contract to Open Data Contract Standard (ODCS) v3.1.0 format by fully qualified name.

get/v1/dataContracts/name/{fqn}/odcs

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/dataContracts/name/{fqn}/odcs
  • Auth: HTTP bearer

Path parameters

fqnstring required

Fully qualified name of the data contract

Query parameters

fieldsstring
Example:owners,reviewers,extension

Fields requested in the returned resource

Response

ODCS data contract

apiVersion'v3.1.0' | 'v3.0.2' | 'v3.0.1' | 'v3.0.0' | 'v2.2.2' | 'v2.2.1' | 'v2.2.0' required
kind'DataContract' required
idstring required
namestring
versionstring required
status'proposed' | 'draft' | 'active' | 'deprecated' | 'retired' required
tenantstring
domainstring
dataProductstring
tagsstring[]
slaDefaultElementstring
contractCreatedTsstring date-time

Changes

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