List quality gate for a dataset version

GET

/v1/dataset-versions/{versionId}/quality-gate

curl -X GET 'https://api.embodiflow.io/v1/dataset-versions/{versionId}/quality-gate' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

versionIdstringrequired

Query parameters

runIdstring (uuid)
Detail truth for a specific run instead of the latest run per version.

Responses

Gate outcome computed from persisted blocking findings of the latest run (or the run named by workflowRunId). estimatedSavings arrives with the W5 gate execution path.

dataobjectrequired
- datasetVersionIdstringrequired
- outcomestringrequired
  Allowed values
  blocked
  not_evaluated
  passed
- notEvaluatedReasonstring | nullrequired
  Allowed values
  never_evaluated
  no_verdict_findings
- workflowRunIdstring | nullrequired
- policySnapshotHashstring | nullrequired
- blockedFileIdsarray<string>required
- blockedEpisodeCountnumberrequired
- blockingFindingCountnumberrequired
- causesarray<QualityGateCauseDto>required
- estimatedSavingsobject

Response example

{
  "data": {
    "datasetVersionId": "string",
    "outcome": "blocked",
    "notEvaluatedReason": "never_evaluated",
    "workflowRunId": "string",
    "policySnapshotHash": "string",
    "blockedFileIds": [
      "string"
    ],
    "blockedEpisodeCount": 0,
    "blockingFindingCount": 0,
    "causes": [
      {
        "findingId": "string",
        "checkId": "string",
        "bindingIdentity": "string",
        "scopeType": "string",
        "scopeRef": "string",
        "datasetVersionFileId": "string",
        "datasetVersionItemId": "string",
        "severity": "string",
        "message": "string",
        "workflowRunId": "string"
      }
    ],
    "estimatedSavings": {
      "label": "estimate",
      "basis": "blocked-files",
      "fileCount": 0,
      "episodesBlocked": 0,
      "totalBytes": 0,
      "canonicalizeMinutes": 0,
      "annotateMinutes": 0
    }
  }
}

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

{ "data": { "datasetVersionId": "string", "outcome": "blocked", "notEvaluatedReason": "never_evaluated", "workflowRunId": "string", "policySnapshotHash": "string", "blockedFileIds": [ "string" ], "blockedEpisodeCount": 0, "blockingFindingCount": 0, "causes": [ { "findingId": "string", "checkId": "string", "bindingIdentity": "string", "scopeType": "string", "scopeRef": "string", "datasetVersionFileId": "string", "datasetVersionItemId": "string", "severity": "string", "message": "string", "workflowRunId": "string" } ], "estimatedSavings": { "label": "estimate", "basis": "blocked-files", "fileCount": 0, "episodesBlocked": 0, "totalBytes": 0, "canonicalizeMinutes": 0, "annotateMinutes": 0 } } }