/v1/test-suite/{testSuiteID}/steps

GET <baseUrl>/v1/test-suite/{testSuiteID}/steps

GET Get all steps for a test suite

Retrieves all steps embedded in the specified test suite.

Parameters

Name In Required Type Description
testSuiteID path Required [string] ID of the test suite

Responses

200 Successfully retrieved shared steps
application/json
Type: [array]
{
  "items": {
    "$ref": "#/components/schemas/TestStep"
  },
  "type": "array"
}
401 Unauthorized - invalid or expired authentication credentials
application/json
Schema: ErrorResponse
500 Server error while retrieving shared steps
application/json
Schema: ErrorResponse

OPTIONS CORS support for steps

Enable CORS by returning correct headers

Responses

200 CORS headers returned

POST Create a new step within a test suite

Creates a new step embedded in the specified test suite.

Parameters

Name In Required Type Description
testSuiteID path Required [string] ID of the test suite

Request Body

Required

Shared step to create

application/json
Schema: TestStep

Responses

201 Successfully created shared step
application/json
Schema: TestStep
400 Bad request - invalid input
application/json
Schema: ErrorResponse
401 Unauthorized - invalid or expired authentication credentials
application/json
Schema: ErrorResponse
500 Server error while creating shared step
application/json
Schema: ErrorResponse

Security

  • apiKeyAuth [apiKey]
    API Key authentication. Use the X-API-KEY header (generated from the Vaktum portal) to authenticate directly to a workspace.
    In: header
    Name: X-API-KEY
  • bearerAuth [http]
    OAuth2 authentication. Use the Authorization header with a Bearer token. Also provide X-WORKSPACE-ID header for workspace context.
    Scheme: bearer
    Bearer Format: JWT