Steps

Managing test steps

Creating a step

post

Create a new step.

Authorizations

tokenAuthBearer

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Body

application/json

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

Responses

201Success

application/json

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

post

/api/v2/steps/

HTTPcURLJavaScriptPython

POST /api/v2/steps/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 264

{
  "atIndex": null,
  "type": "text",
  "name": null,
  "blockId": null,
  "groupId": null,
  "notes": null,
  "isActive": true,
  "runTimeout": null,
  "sleep": null,
  "waitingConditions": [
    {
      "type": "documentComplete",
      "expected": null,
      "isActive": true,
      "isOverridden": true,
      "timeout": null
    }
  ],
  "value": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "name": null,
  "blockId": null,
  "groupId": null,
  "originGroupId": "text",
  "notes": null,
  "isActive": true,
  "runTimeout": null,
  "sleep": null,
  "waitingConditions": [
    {
      "type": "documentComplete",
      "expected": null,
      "isActive": true,
      "timeout": null
    }
  ],
  "value": "text"
}

Retrieving step by ID

get

Return a single step.

Authorizations

tokenAuthBearer

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this step.

Responses

200Success

application/json

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

401

Authentication credentials were missing or invalid.

404

Resource not found.

get

/api/v2/steps/{id}/

HTTPcURLJavaScriptPython

GET /api/v2/steps/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "name": null,
  "blockId": null,
  "groupId": null,
  "originGroupId": "text",
  "notes": null,
  "isActive": true,
  "runTimeout": null,
  "sleep": null,
  "waitingConditions": [
    {
      "type": "documentComplete",
      "expected": null,
      "isActive": true,
      "timeout": null
    }
  ],
  "value": "text"
}

Updating a step

put

Authorizations

tokenAuthBearer

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this step.

Body

application/json

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

Responses

200Success

application/json

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

404

Resource not found.

put

/api/v2/steps/{id}/

HTTPcURLJavaScriptPython

PUT /api/v2/steps/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 264

{
  "atIndex": null,
  "type": "text",
  "name": null,
  "blockId": null,
  "groupId": null,
  "notes": null,
  "isActive": true,
  "runTimeout": null,
  "sleep": null,
  "waitingConditions": [
    {
      "type": "documentComplete",
      "expected": null,
      "isActive": true,
      "isOverridden": true,
      "timeout": null
    }
  ],
  "value": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "name": null,
  "blockId": null,
  "groupId": null,
  "originGroupId": "text",
  "notes": null,
  "isActive": true,
  "runTimeout": null,
  "sleep": null,
  "waitingConditions": [
    {
      "type": "documentComplete",
      "expected": null,
      "isActive": true,
      "timeout": null
    }
  ],
  "value": "text"
}

Removing a step

delete

Remove a step.

Authorizations

tokenAuthBearer

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this step.

Responses

204

No response body

401

Authentication credentials were missing or invalid.

404

Resource not found.

delete

/api/v2/steps/{id}/

HTTPcURLJavaScriptPython

DELETE /api/v2/steps/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Partially updating a step

patch

Authorizations

tokenAuthBearer

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this step.

Body

application/json

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

Responses

200Success

application/json

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

404

Resource not found.

patch

/api/v2/steps/{id}/

HTTPcURLJavaScriptPython

PATCH /api/v2/steps/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 264

{
  "atIndex": null,
  "type": "text",
  "name": null,
  "blockId": null,
  "groupId": null,
  "notes": null,
  "isActive": true,
  "runTimeout": null,
  "sleep": null,
  "waitingConditions": [
    {
      "type": "documentComplete",
      "expected": null,
      "isActive": true,
      "isOverridden": true,
      "timeout": null
    }
  ],
  "value": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "name": null,
  "blockId": null,
  "groupId": null,
  "originGroupId": "text",
  "notes": null,
  "isActive": true,
  "runTimeout": null,
  "sleep": null,
  "waitingConditions": [
    {
      "type": "documentComplete",
      "expected": null,
      "isActive": true,
      "timeout": null
    }
  ],
  "value": "text"
}