API Reference

Scenarios API

Scenario management.

Overview

Manage test scenarios linked to requirements and test types.

Use organization-scoped API keys with Bearer authentication. All responses are JSON unless downloading binary report artifacts. List endpoints support cursor pagination; mutating operations accept Idempotency-Key headers.

Who should read this

  • Engineers building automation against Zof for CMDB sync, CI gates, reporting, and integration health checks.

Prerequisites

  • API key with read access minimum; write operations require appropriate role
  • Familiarity with REST and JSON

Scenarios workflow

Scenarios workflow

Typical integration pattern

Best practices

  • Test mutations in staging before production automation
  • Cache resource IDs from list responses; avoid hard-coding in multiple services
  • Subscribe to webhooks for run completion instead of polling where possible

API operations

GET
/scenarios
Filter scenarios by project, test type, or requirement.
POST
/scenarios
Create scenario with name, description, and linked requirement IDs.
GET
/scenarios/{id}
Fetch scenario with linked cases and coverage mapping.
PATCH
/scenarios/{id}
Edit metadata or relink requirements after review.
DELETE
/scenarios/{id}
Remove scenario if no active release gates reference it.
POST
/scenarios/{id}/validate
Run structural validation on scenario and linked cases.

Was this page helpful?