Test Plans

Create a test plan

Creates an empty test plan in a workspace. Add cases with POST /api/plans/{planId}/cases, then trigger it with POST /api/triggers/plans/{planId}/run. Plans created via the API have API access enabled by default.

post/api/plans

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/plans/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

projectIdstring uuid required

ID of the workspace to create the plan in.

titlestring required

descriptionstring nullable

executionMode'parallel' | 'sequential'

stopOnFailureboolean

Stop remaining cases after a failure. Sequential runs only.

deviceMode'pool' | 'matrix'

pool: each case runs once on whichever configured device is free. matrix: each case runs on every configured device.

Response

Plan created.

successboolean required

planIdstring uuid required

Example response

{
  "success": true
}

Changes

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