Manage Test Steps Using API

With Testsigma, you can create, update, retrieve, and delete test steps in a test case using the REST API. You can also perform bulk operations for efficiency and search NLP templates for step creation.

Prerequisites

Before you begin, ensure you have:

1. testCaseId: You can find it in the URL of the test case in the Testsigma app.
2. previousStepId: The ID of the step after which the new step should be added. You can get it from the response of List Test Case Steps Using the REST API.
3. templateId: The ID of the NLP template that defines the action. You can get it by searching with the Search NLP Templates Using REST API.

Create a Test Step Using API

This endpoint allows users to create one step in a test case.

{
  "testCaseId": 9,
  "templateId": 1044,
  "previousStepId": 223,
  "elementId": 567,
  "text": "https://www.google.com",
  "type": "NLP_TEXT"
}

{
  "id": 5846,
  "action": "Navigate to https://www.google.com",
  "type": "NLP_TEXT",
  "conditionType": null,
  "testCaseId": 9,
  "stepGroupId": null
}

Request Fields:

• testCaseId: The ID of the test case where you want to add the new step.
• templateId: A unique identifier for the type of action you're performing (e.g., navigating to a URL).
• elementId: The ID of the element associated with this step (required for templates with ${ui-identifier} in grammar).
• previousStepId: The ID of the step that the new step should follow.
• text: The value of the step's action, in this case, the URL to navigate to.

• type: The type of the test step. We support both:

  • NLP_TEXT: For Natural Language Processing text steps.
  • STEP_GROUP: For a group of multiple steps executed together.

Response Body Fields

• id: A unique numerical identifier for the newly created test step.
• action: A human-readable description of the action the test step performs, such as "Navigate to https://www.google.com".

• type: The type of the test step. We support both:

  • NLP_TEXT: For Natural Language Processing text steps.
  • STEP_GROUP: For a group of multiple steps executed together.

Create Multiple Test Steps Using API

This endpoint allows users to create multiple test steps in a single request.

{
  "testCaseId": 9,
  "steps": [
    {
      "templateId": 1044,
      "elementId": 567,
      "text": "https://www.google.com",
      "type": "NLP_TEXT"
    },
    {
      "templateId": 37,
      "type": "NLP_TEXT"
    }
  ]
}

Returns an array of newly created test step objects.

Request Fields:

• testCaseId: Target test case ID
• steps: Array of step objects
• templateId: NLP template ID for the step
• elementId: The ID of the element associated with this step (required for templates with ${ui-identifier} in grammar).
• text: Step input or parameter value

• type: The type of the test step. We support both:

  • NLP_TEXT: For Natural Language Processing text steps.
  • STEP_GROUP: For a group of multiple steps executed together.

Retrieve a Test Step Using API

This endpoint allows users to fetch a specific test step by ID.

{
  "id": 12345,
  "action": "Click on the login button",
  "type": "NLP_TEXT",
  "stepOrder": 1.0,
  "testCaseId": 123,
  "templateId": 456,
  ...
}

Response Fields

• id: Step ID
• action: Action description
• type: Step type
• stepOrder: Execution order in the test case
• testCaseId: Parent test case ID
• templateId: Associated template

List Test Case Steps Using API

This endpoint retrieves all steps of a specific test case in their execution order.

Returns an array of test step objects in step sequence order

Search NLP Templates Using API

This endpoint allows users to search NLP templates for creating steps.

[
  {
    "id": 456,
    "keyword": "click",
    "grammar": "Click on the ${ui-identifier}",
    "action": "click"
  }
]

Response Fields:

• id: Unique identifier of the created test step
• keyword: Keyword associated with the step (e.g., click)
• grammar: NLP grammar expression for the step
• action : Action executed by the step

Update a Test Step Using API

This endpoint allows users to update an existing test step.

{
  "testCaseId": 9,
  "templateId": 1044,
  "elementId": 567,
  "text": "your password",
  "type": "NLP_TEXT"
}

{
  "id": 12,
  "action": "Enter password in the Enter Password field",
  "type": "NLP_TEXT",
  "conditionType": null,
  "testCaseId": 1,
  "stepGroupId": null
}

Request Fields:

• testCaseId: Target test case ID where the step will be created
• templateId: NLP template ID for the step
• elementId: The ID of the element associated with this step (required for templates with ${ui-identifier} in grammar).
• text: Step input or parameter value

• type: The type of the test step. We support both:

  • NLP_TEXT: For Natural Language Processing text steps.
  • STEP_GROUP: For a group of multiple steps executed together.

Response Fields:

• id: Unique identifier of the created test step
• action: Action description generated from the step (e.g., Enter password…)

• type: The type of the test step. We support both:

  • NLP_TEXT: For Natural Language Processing text steps.
  • STEP_GROUP: For a group of multiple steps executed together.

Delete a Test Step Using API

This endpoint allows users to delete a specific test step from a test case.