From sign-in to evidence

Use the web sign-in page for the console. Use the login endpoint for an API client. The current OpenAPI contract advertises bearer JWT authentication.

BASE_URL="https://your-cadlytic-host"

curl -sS -X POST "$BASE_URL/api/auth/login" \
  -H "Content-Type: application/json" \
  -d '{"email":"<YOUR_EMAIL>","password":"<YOUR_PASSWORD>"}'

Read access_token from the successful response. Do not print it or save it in source control. Send it as a bearer token.

TOKEN="<YOUR_TOKEN>"

curl -sS "$BASE_URL/api/auth/me" \
  -H "Authorization: Bearer $TOKEN"

A registered row is not proof that a runner can take work. Read liveness and dispatchable. Run only when the server reports dispatchable: true.

1. 1
   Sign in and select the project you want to test.
2. 2
   Open Quality → Test Cases.
3. 3
   Create a test case. Add ordered steps and an expected result for each step. Save the draft.
4. 4
   Open the case's test design. Save executable content before approval.
5. 5
   Review and approve the design. Approval freezes that version.
6. 6
   Select Run. The server checks the design, target, and runner before dispatch.

Open Quality → Runs. Read three facts separately:

• Execution status says whether the request is queued, running, or terminal.
• Outcome says passed, failed, or error. A missing outcome is not a pass.
• Evidence is the captured artifact record. Check availability, integrity, and provenance.

For a ticket, the test-result endpoint composes the recorded result. The evidence endpoint lists its artifacts. Do not infer a verdict from an artifact count.

PROJECT_ID="<PROJECT_ID>"

curl -sS "$BASE_URL/api/v1/projects" \
  -H "Authorization: Bearer <YOUR_TOKEN>"

curl -sS "$BASE_URL/api/v2/requirements?projectId=$PROJECT_ID" \
  -H "Authorization: Bearer <YOUR_TOKEN>"

curl -sS "$BASE_URL/api/v2/qa/tests/cases?projectId=$PROJECT_ID&page=0&size=20" \
  -H "Authorization: Bearer <YOUR_TOKEN>"

curl -sS "$BASE_URL/api/v2/quality/designs?projectId=$PROJECT_ID" \
  -H "Authorization: Bearer <YOUR_TOKEN>"

curl -sS "$BASE_URL/api/v2/quality/executions/runs?projectId=$PROJECT_ID&page=0&size=20" \
  -H "Authorization: Bearer <YOUR_TOKEN>"

curl -sS "$BASE_URL/api/v2/quality/runners" \
  -H "Authorization: Bearer <YOUR_TOKEN>"

The server owns readiness. Show its unrunnable_reason, blocked_reason, or failure sentence without replacing it.

This list comes from the authenticated OpenAPI document served by the local backend. Query parameter names are case-sensitive. Request bodies use snake_case.