Create a contract check request

POST

/v1/dataset-versions/{versionId}/contract-check-requests

curl -X POST 'https://api.embodiflow.io/v1/dataset-versions/{versionId}/contract-check-requests' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "contractRevisionId": "string"
  }'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

versionIdstringrequired

Header parameters

Idempotency-Keystring
Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.

Request body

Content-Typeapplication/json

contractRevisionIdstringrequired

Responses

Success

dataobjectrequired
- idstringrequired
- datasetVersionIdstringrequired
- contractRevisionIdstringrequired
- statusstringrequired
- summaryobjectrequired
- checkResultsarray<AssetCheckResultDto>required
- createdAtstringrequired

Response example

{
  "data": {
    "id": "string",
    "datasetVersionId": "string",
    "contractRevisionId": "string",
    "status": "string",
    "summary": {
      "overallStatus": "failed",
      "blockingFailed": false,
      "passedCount": 0,
      "warningCount": 0,
      "failedCount": 0,
      "skippedCount": 0,
      "findings": [
        {
          "scope": "topic",
          "field": "string",
          "expected": "string",
          "actual": "string",
          "message": "string",
          "status": "failed",
          "blocking": false
        }
      ]
    },
    "checkResults": [
      {
        "id": "string",
        "tenantId": "string",
        "projectId": "string",
        "assetType": "string",
        "assetId": "string",
        "datasetVersionId": "string",
        "checkCode": "string",
        "targetScope": "string",
        "targetId": "string",
        "status": "failed",
        "severity": "info",
        "blocking": false,
        "metadataJson": {},
        "contractRevisionId": "string",
        "createdAt": "string"
      }
    ],
    "createdAt": "string"
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1