Data Contracts

Create or update data contract from ODCS YAML format

Create or update a data contract from Open Data Contract Standard (ODCS) v3.1.0 YAML format. Use mode=merge (default) to preserve existing fields not in the import. Use mode=replace to fully overwrite the contract while preserving ID and execution history.

put/v1/dataContracts/odcs/yaml

Request

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

Query parameters

entityIdstring uuid

Entity ID to associate with the contract

entityTypestring
Example:table

Entity Type (table, topic, etc.)

mode'merge' | 'replace'

Import mode: 'merge' preserves existing fields, 'replace' overwrites all fields

objectNamestring

Schema object name to import (for multi-object ODCS contracts). If not specified, auto-selects based on entity name or uses first object.

Response

The created or updated data contract

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.