PUT /v1/dataContracts

curl -X PUT "{base_url}/api/v1/dataContracts" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "sales-orders-contract",
    "entity": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "type": "table"
    },
    "description": "Data contract for the sales orders table",
    "entityStatus": "Approved",
    "schema": [
      {"name": "order_id", "dataType": "INT", "constraint": "PRIMARY_KEY"},
      {"name": "order_date", "dataType": "TIMESTAMP", "constraint": "NOT_NULL"}
    ],
    "semantics": [
      {
        "name": "Owners is set",
        "description": "The table must have an owner.",
        "rule": "{\"and\":[{\"some\":[{\"var\":\"owners\"},{\"!=\":[{\"var\":\"fullyQualifiedName\"},null]}]}]}",
        "enabled": true
      }
    ],
    "sla": {
      "refreshFrequency": {"interval": 1, "unit": "day"}
    }
  }'

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"
)

# Update contract description and status
contract = DataContracts.retrieve("f7a1b2c3-d4e5-6789-0abc-def123456789")
contract.description = "Updated contract for sales orders table"
contract.entityStatus = "Approved"
contract = DataContracts.update(contract)

import static org.openmetadata.sdk.fluent.DataContracts.*;

// Update using fluent API
FluentDataContract contract = find(contractId).fetch();
contract.withDescription("Updated contract for sales orders table")
    .withStatus(EntityStatus.APPROVED)
    .save();

# Update description
curl -X PATCH "{base_url}/api/v1/dataContracts/f7a1b2c3-d4e5-6789-0abc-def123456789" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated contract for sales orders table"},
    {"op": "replace", "path": "/entityStatus", "value": "Approved"}
  ]'

# Add a semantic rule
curl -X PATCH "{base_url}/api/v1/dataContracts/f7a1b2c3-d4e5-6789-0abc-def123456789" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "add", "path": "/semantics/-", "value": {
      "name": "Domain is set",
      "description": "The table must belong to a domain.",
      "rule": "{\"some\":[{\"var\":\"domains\"},{\"!=\":[{\"var\":\"fullyQualifiedName\"},null]}]}",
      "enabled": true
    }}
  ]'

{
  "id": "f7a1b2c3-d4e5-6789-0abc-def123456789",
  "name": "sales-orders-contract",
  "fullyQualifiedName": "sample_data.ecommerce_db.shopify.sales_orders.dataContract_sales-orders-contract",
  "description": "Updated contract for sales orders table",
  "entityStatus": "Approved",
  "entity": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "type": "table",
    "name": "sales_orders",
    "fullyQualifiedName": "sample_data.ecommerce_db.shopify.sales_orders"
  },
  "version": 0.2,
  "updatedAt": 1769986400000,
  "updatedBy": "admin",
  "changeDescription": {
    "fieldsUpdated": [
      {"name": "description", "oldValue": "Data contract for the sales orders table", "newValue": "Updated contract for sales orders table"},
      {"name": "entityStatus", "oldValue": "Draft", "newValue": "Approved"}
    ]
  }
}

PUT

dataContracts

PUT /v1/dataContracts

curl -X PUT "{base_url}/api/v1/dataContracts" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "sales-orders-contract",
    "entity": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "type": "table"
    },
    "description": "Data contract for the sales orders table",
    "entityStatus": "Approved",
    "schema": [
      {"name": "order_id", "dataType": "INT", "constraint": "PRIMARY_KEY"},
      {"name": "order_date", "dataType": "TIMESTAMP", "constraint": "NOT_NULL"}
    ],
    "semantics": [
      {
        "name": "Owners is set",
        "description": "The table must have an owner.",
        "rule": "{\"and\":[{\"some\":[{\"var\":\"owners\"},{\"!=\":[{\"var\":\"fullyQualifiedName\"},null]}]}]}",
        "enabled": true
      }
    ],
    "sla": {
      "refreshFrequency": {"interval": 1, "unit": "day"}
    }
  }'

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"
)

# Update contract description and status
contract = DataContracts.retrieve("f7a1b2c3-d4e5-6789-0abc-def123456789")
contract.description = "Updated contract for sales orders table"
contract.entityStatus = "Approved"
contract = DataContracts.update(contract)

import static org.openmetadata.sdk.fluent.DataContracts.*;

// Update using fluent API
FluentDataContract contract = find(contractId).fetch();
contract.withDescription("Updated contract for sales orders table")
    .withStatus(EntityStatus.APPROVED)
    .save();

# Update description
curl -X PATCH "{base_url}/api/v1/dataContracts/f7a1b2c3-d4e5-6789-0abc-def123456789" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated contract for sales orders table"},
    {"op": "replace", "path": "/entityStatus", "value": "Approved"}
  ]'

# Add a semantic rule
curl -X PATCH "{base_url}/api/v1/dataContracts/f7a1b2c3-d4e5-6789-0abc-def123456789" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "add", "path": "/semantics/-", "value": {
      "name": "Domain is set",
      "description": "The table must belong to a domain.",
      "rule": "{\"some\":[{\"var\":\"domains\"},{\"!=\":[{\"var\":\"fullyQualifiedName\"},null]}]}",
      "enabled": true
    }}
  ]'

{
  "id": "f7a1b2c3-d4e5-6789-0abc-def123456789",
  "name": "sales-orders-contract",
  "fullyQualifiedName": "sample_data.ecommerce_db.shopify.sales_orders.dataContract_sales-orders-contract",
  "description": "Updated contract for sales orders table",
  "entityStatus": "Approved",
  "entity": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "type": "table",
    "name": "sales_orders",
    "fullyQualifiedName": "sample_data.ecommerce_db.shopify.sales_orders"
  },
  "version": 0.2,
  "updatedAt": 1769986400000,
  "updatedBy": "admin",
  "changeDescription": {
    "fieldsUpdated": [
      {"name": "description", "oldValue": "Data contract for the sales orders table", "newValue": "Updated contract for sales orders table"},
      {"name": "entityStatus", "oldValue": "Draft", "newValue": "Approved"}
    ]
  }
}

Update a Data Contract

Create a data contract or update it if it already exists, using PUT /v1/dataContracts with the full request body. Send the complete definition, not just the fields you want to change. To change only some fields, use PATCH with a JSON Patch array and the application/json-patch+json content type, as shown in the PATCH examples below.

Body Parameters

string

required

Name of the data contract, 1 to 256 characters. The contract’s fully qualified name is <entityFQN>.dataContract_<name>.

object

required

Reference to the data asset this contract applies to. An entity can have only one contract.

Show properties

string

required

UUID of the entity.

string

required

Entity type. See Supported Entity Types.

string

Human-readable display name.

string

Description in Markdown format.

string

default:"Draft"

Contract status: Draft, In Review, Approved, Rejected, Deprecated, or Archived.

array

Expected columns or fields. Supported for table, topic, apiEndpoint, and dashboardDataModel only. Each item follows the Column schema. Every name must exist on the entity, and no name can repeat.

Show properties

string

required

Column or field name.

string

required

Data type, for example INT, VARCHAR, or TIMESTAMP.

integer

Length for types such as VARCHAR.

string

Constraint: NULL, NOT_NULL, UNIQUE, PRIMARY_KEY.

string

Column description.

array

Semantics rules evaluated against the entity’s metadata when the contract is validated.

Show properties

string

required

Rule name.

string

required

Rule description. Reported as the failure reason when the rule fails.

string

required

JSON Logic expression. The rule passes when it returns true.

boolean

default:"true"

Whether the rule is evaluated.

string

Apply the rule only to this entity type.

array

Entity types the rule skips.

array

References to test cases that must pass. Supported for table only.

Show properties

string

required

UUID of the test case.

string

required

Must be testCase.

object

Service level agreement expectations. Stored and shown on the contract. Validation runs check it for tables, except retention.

Show properties

object

interval (integer) and unit: hour, day, week, month, or year.

object

value (integer) and unit: minute, hour, or day.

string

Time of day the data should be available, for example 09:00.

string

default:"GMT+00:00 (Europe/London)"

Timezone for availabilityTime, in the form GMT+05:30 (Asia/Kolkata).

object

period (integer) and unit: day, week, month, or year.

string

Column that holds the data’s refresh time.

string

Terms of use in Markdown format. Describes allowed and disallowed uses and compliance requirements. Returned as termsOfUse.content on the contract.

object

Security and access expectations. Stored and shown on the contract, but not enforced.

Show properties

string

Classification of the data, for example PII or Confidential.

array

Access policies. Each has accessPolicy (policy name), identities (consumer groups or users), and rowFilters (a list of columnName and values).

array

Owner references (users or teams).

array

Reviewer references (users or teams). When set, only a reviewer can move the contract from In Review to Approved or Rejected.

string

Date and time from which this contract is effective. Informational only.

string

Date and time until which this contract is effective. Informational only.

string

Link to where the contract is maintained.

PUT /v1/dataContracts

curl -X PUT "{base_url}/api/v1/dataContracts" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "sales-orders-contract",
    "entity": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "type": "table"
    },
    "description": "Data contract for the sales orders table",
    "entityStatus": "Approved",
    "schema": [
      {"name": "order_id", "dataType": "INT", "constraint": "PRIMARY_KEY"},
      {"name": "order_date", "dataType": "TIMESTAMP", "constraint": "NOT_NULL"}
    ],
    "semantics": [
      {
        "name": "Owners is set",
        "description": "The table must have an owner.",
        "rule": "{\"and\":[{\"some\":[{\"var\":\"owners\"},{\"!=\":[{\"var\":\"fullyQualifiedName\"},null]}]}]}",
        "enabled": true
      }
    ],
    "sla": {
      "refreshFrequency": {"interval": 1, "unit": "day"}
    }
  }'

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"
)

# Update contract description and status
contract = DataContracts.retrieve("f7a1b2c3-d4e5-6789-0abc-def123456789")
contract.description = "Updated contract for sales orders table"
contract.entityStatus = "Approved"
contract = DataContracts.update(contract)

import static org.openmetadata.sdk.fluent.DataContracts.*;

// Update using fluent API
FluentDataContract contract = find(contractId).fetch();
contract.withDescription("Updated contract for sales orders table")
    .withStatus(EntityStatus.APPROVED)
    .save();

# Update description
curl -X PATCH "{base_url}/api/v1/dataContracts/f7a1b2c3-d4e5-6789-0abc-def123456789" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated contract for sales orders table"},
    {"op": "replace", "path": "/entityStatus", "value": "Approved"}
  ]'

# Add a semantic rule
curl -X PATCH "{base_url}/api/v1/dataContracts/f7a1b2c3-d4e5-6789-0abc-def123456789" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "add", "path": "/semantics/-", "value": {
      "name": "Domain is set",
      "description": "The table must belong to a domain.",
      "rule": "{\"some\":[{\"var\":\"domains\"},{\"!=\":[{\"var\":\"fullyQualifiedName\"},null]}]}",
      "enabled": true
    }}
  ]'

{
  "id": "f7a1b2c3-d4e5-6789-0abc-def123456789",
  "name": "sales-orders-contract",
  "fullyQualifiedName": "sample_data.ecommerce_db.shopify.sales_orders.dataContract_sales-orders-contract",
  "description": "Updated contract for sales orders table",
  "entityStatus": "Approved",
  "entity": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "type": "table",
    "name": "sales_orders",
    "fullyQualifiedName": "sample_data.ecommerce_db.shopify.sales_orders"
  },
  "version": 0.2,
  "updatedAt": 1769986400000,
  "updatedBy": "admin",
  "changeDescription": {
    "fieldsUpdated": [
      {"name": "description", "oldValue": "Data contract for the sales orders table", "newValue": "Updated contract for sales orders table"},
      {"name": "entityStatus", "oldValue": "Draft", "newValue": "Approved"}
    ]
  }
}

Common Patch Operations

Operation	Path	Description
`replace`	`/description`	Update description
`replace`	`/entityStatus`	Change status (`Draft`, `In Review`, `Approved`, `Rejected`, `Deprecated`, `Archived`)
`add`	`/semantics/-`	Add a semantic rule
`remove`	`/semantics/0`	Remove a semantic rule by index
`replace`	`/sla`	Update SLA section
`add`	`/schema/-`	Add a schema column

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid or malformed request body
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to update data contracts

API Reference

Data Assets

Collaboration

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Alerts

Incidents

Main Concepts

Update a Data Contract

Update a Data Contract

Body Parameters

Common Patch Operations

Error Handling