Test Cases

Save a session as a test case

Persists a finished agent session as a reusable test case and links the two. The session must be in a terminal state (succeeded, failed, terminated, error) and not already linked to a case. The scenario defaults to the session summary; mobile, web and local desktop run configuration is carried over automatically.

The created case has API access enabled by default, so it can be triggered immediately with POST /api/triggers/cases/{caseId}/run.

post/api/sessions/{sessionId}/save-as-case

Request

Base URL
https://aximo.autify.com
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/autify/apis/aximo-api/docs/api/sessions/:sessionId/save-as-case/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

sessionIdstring uuid required

Session UUID to save as a case.

Request body

titlestring

Case title. Defaults to the session title.

type'web' | 'mobile' | 'desktop'

Case type. Inferred from the session if omitted. A session on a registered local desktop saves as desktop bound to that desktop, and a cloud desktop session as web.

scenariostring

Scenario text. Defaults to the session summary.

format'gherkin' | 'markdown' | 'plain_text'

Scenario format.

Response

Case created from the session.

successboolean required

caseIdstring uuid required

projectIdstring uuid required

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.