Create a preview request

POST

/v1/quality-rule-sets/{ruleSetId}/preview-requests

curl -X POST 'https://api.embodiflow.io/v1/quality-rule-sets/{ruleSetId}/preview-requests' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "datasetVersionId": "00000000-0000-0000-0000-000000000000",
    "ruleSetDraft": {}
  }'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

ruleSetIdstringrequired

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

datasetVersionIdstring (uuid)required
ruleSetDraftobject

Responses

Success

dataobjectrequired
- qualityRuleSetIdstringrequired
- projectIdstringrequired
- datasetVersionIdstringrequired
- usedDraftone ofrequired
- summaryobjectrequired
- findingsarray<QualityRuleSetPreviewFindingDto>required
- diagnosticsarray<QualityRuleSetPreviewDiagnosticDto>required
- versionFindingsarray<object>required
- policySnapshotHashstring
- metricsDocumentSourcestring | null
- draftPolicyErrorstring | null
- checksarray<QualityRuleSetPreviewCheckDto>

Response example

{
  "data": {
    "qualityRuleSetId": "string",
    "projectId": "string",
    "datasetVersionId": "string",
    "usedDraft": false,
    "summary": {
      "overallStatus": "failed",
      "passedCount": 0,
      "warningCount": 0,
      "failedCount": 0,
      "fileCount": 0,
      "visibilityStatus": "active",
      "notEvaluatedCount": 0
    },
    "findings": [
      {
        "datasetVersionFileId": "string",
        "logicalPath": "string",
        "qualityStatus": "failed",
        "details": [
          {}
        ]
      }
    ],
    "diagnostics": [
      {
        "severity": "warning",
        "code": "string",
        "message": "string",
        "details": {}
      }
    ],
    "versionFindings": [
      {}
    ],
    "policySnapshotHash": "string",
    "metricsDocumentSource": "string",
    "draftPolicyError": "string",
    "checks": [
      {
        "checkId": "string",
        "bindingIdentity": "string",
        "ruleVersion": 0,
        "family": "string",
        "enabled": false,
        "severity": "string",
        "blocking": false,
        "verdict": "warn",
        "nonVerdictReason": "string",
        "status": "string",
        "message": "string",
        "findingCount": 0,
        "previewSupported": false
      }
    ]
  }
}

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