Create a Data Contract

Create a new data contract for a data asset

POST /v1/dataContracts

POST /v1/dataContracts

Python

from metadata.sdk import configure
from metadata.sdk.entities import DataContracts

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Create a basic data contract for a table
contract = DataContracts.create(
    name="sales-orders-contract",
    entity={
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "type": "table"
    },
    description="Data contract for the sales orders table",
    entityStatus="Active",
    schema=[
        {"name": "order_id", "dataType": "INT", "constraint": "PRIMARY_KEY"},
        {"name": "customer_id", "dataType": "INT", "constraint": "NOT_NULL"},
        {"name": "order_date", "dataType": "TIMESTAMP", "constraint": "NOT_NULL"},
        {"name": "total_amount", "dataType": "DECIMAL"}
    ],
    semantics=[
        {"name": "hasOwner"},
        {"name": "hasDescription"},
        {"name": "hasTags"}
    ],
    sla={
        "refreshFrequency": "PT1H",
        "availability": 99.9
    }
)
print(f"Created contract: {contract.fullyQualifiedName}")

Response

{
  "id": "f7a1b2c3-d4e5-6789-0abc-def123456789",
  "name": "sales-orders-contract",
  "fullyQualifiedName": "sales-orders-contract",
  "displayName": "sales-orders-contract",
  "description": "Data contract for the sales orders table",
  "entityStatus": "Active",
  "entity": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "type": "table",
    "name": "sales_orders",
    "fullyQualifiedName": "sample_data.ecommerce_db.shopify.sales_orders"
  },
  "schema": [
    {"name": "order_id", "dataType": "INT", "constraint": "PRIMARY_KEY"},
    {"name": "customer_id", "dataType": "INT", "constraint": "NOT_NULL"},
    {"name": "order_date", "dataType": "TIMESTAMP", "constraint": "NOT_NULL"},
    {"name": "total_amount", "dataType": "DECIMAL"}
  ],
  "semantics": [
    {"name": "hasOwner"},
    {"name": "hasDescription"},
    {"name": "hasTags"}
  ],
  "sla": {
    "refreshFrequency": "PT1H",
    "availability": 99.9
  },
  "version": 0.1,
  "updatedAt": 1769982800000,
  "updatedBy": "admin"
}

Create a Data Contract

Create a new data contract and attach it to a data asset. Only the name and entity reference are required — all other sections (schema, semantics, quality, SLA, security, terms of use) are optional.

Body Parameters

name · string · required

Name of the data contract. Must be unique.

entity · object · required

Reference to the data asset this contract applies to.

Show properties

id · string · required

UUID of the entity.

type · string · required

Entity type: table, topic, apiEndpoint, dashboardDataModel, storedProcedure, database, databaseSchema, dashboard, chart, pipeline, searchIndex, apiCollection, mlmodel, container, dataProduct.

displayName · string

Human-readable display name.

description · string

Description in Markdown format.

entityStatus · string · default: "Draft"

Contract status: Draft, Active, or Deprecated.

schema · array

Expected column definitions. Each item follows the Column schema.

Show properties

name · string · required

Column name.

dataType · string · required

Data type (e.g., INT, VARCHAR, TIMESTAMP).

constraint · string

Constraint: NULL, NOT_NULL, UNIQUE, PRIMARY_KEY.

description · string

Column description.

semantics · array

Semantics rules defining business expectations.

Show properties

name · string · required

Rule name (e.g., hasOwner, hasDescription, hasDomain, hasTags).

args · object

Rule arguments (varies by rule type).

qualityExpectations · array

References to test cases that must pass.

Show properties

id · string · required

UUID of the test case.

type · string · required

Must be testCase.

sla · object

Service level agreement expectations.

Show properties

refreshFrequency · string

Expected refresh frequency in ISO 8601 duration (e.g., PT1H, P1D).

maxLatency · integer

Maximum acceptable latency in milliseconds.

availability · number

Target availability percentage (0-100).

termsOfUse · string

Terms of use in Markdown format. Describes allowed/disallowed use cases and compliance requirements.

security · object

Security and access policy expectations.

Show properties

accessPolicy · string

Access policy description.

requiredClassifications · array

Required classification tags (e.g., PII.Sensitive).

owners · array

Owner references (users or teams).

reviewers · array

Reviewer user references.

effectiveFrom · string

ISO 8601 date from which this contract is effective.

effectiveUntil · string

ISO 8601 date until which this contract is effective.

POST /v1/dataContracts

Python

from metadata.sdk import configure
from metadata.sdk.entities import DataContracts

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Create a basic data contract for a table
contract = DataContracts.create(
    name="sales-orders-contract",
    entity={
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "type": "table"
    },
    description="Data contract for the sales orders table",
    entityStatus="Active",
    schema=[
        {"name": "order_id", "dataType": "INT", "constraint": "PRIMARY_KEY"},
        {"name": "customer_id", "dataType": "INT", "constraint": "NOT_NULL"},
        {"name": "order_date", "dataType": "TIMESTAMP", "constraint": "NOT_NULL"},
        {"name": "total_amount", "dataType": "DECIMAL"}
    ],
    semantics=[
        {"name": "hasOwner"},
        {"name": "hasDescription"},
        {"name": "hasTags"}
    ],
    sla={
        "refreshFrequency": "PT1H",
        "availability": 99.9
    }
)
print(f"Created contract: {contract.fullyQualifiedName}")

Response

{
  "id": "f7a1b2c3-d4e5-6789-0abc-def123456789",
  "name": "sales-orders-contract",
  "fullyQualifiedName": "sales-orders-contract",
  "displayName": "sales-orders-contract",
  "description": "Data contract for the sales orders table",
  "entityStatus": "Active",
  "entity": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "type": "table",
    "name": "sales_orders",
    "fullyQualifiedName": "sample_data.ecommerce_db.shopify.sales_orders"
  },
  "schema": [
    {"name": "order_id", "dataType": "INT", "constraint": "PRIMARY_KEY"},
    {"name": "customer_id", "dataType": "INT", "constraint": "NOT_NULL"},
    {"name": "order_date", "dataType": "TIMESTAMP", "constraint": "NOT_NULL"},
    {"name": "total_amount", "dataType": "DECIMAL"}
  ],
  "semantics": [
    {"name": "hasOwner"},
    {"name": "hasDescription"},
    {"name": "hasTags"}
  ],
  "sla": {
    "refreshFrequency": "PT1H",
    "availability": 99.9
  },
  "version": 0.1,
  "updatedAt": 1769982800000,
  "updatedBy": "admin"
}

---

Upsert (Create or Update)

Use PUT /v1/dataContracts with the same body to create a new contract or update an existing one.

---

Error Handling

Code	Error Type	Description
400	BAD_REQUEST	Invalid request body or missing required fields
401	UNAUTHORIZED	Invalid or missing authentication token
403	FORBIDDEN	User lacks permission to create data contracts
409	CONFLICT	A contract with the same name already exists