Create a contract check request
POST
/v1/dataset-versions/{versionId}/contract-check-requestscurl -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"
}'认证
每个请求都需要携带个人访问令牌（PAT）。
- Authorization: Bearer PAT
路径参数
- versionIdstring必填
请求头参数
- 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.
请求体
Content-Typeapplication/json
- contractRevisionIdstring必填
响应
Success
- dataobject必填
- idstring必填
- datasetVersionIdstring必填
- contractRevisionIdstring必填
- statusstring必填
- summaryobject必填
- checkResultsarray<AssetCheckResultDto>必填
- createdAtstring必填
响应示例
{
"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"
}
}服务器https://api.embodiflow.io/v1https://api.embodiflow.dev/v1