From 3ccf40f64ecfd8ee7768db9f704831d5d87bba5c Mon Sep 17 00:00:00 2001 From: Bharath Krishna <118433150+bharathk08@users.noreply.github.com> Date: Thu, 6 Jun 2024 10:51:51 +0530 Subject: [PATCH] Updated APIs Result & Agent Soft Delete pages --- .../soft-and-permanent-deletion-of-agents.md | 67 +++++ src/pages/docs/agent/soft-delete-agents.md | 50 ---- .../docs/api/test-results-at-all-levels.md | 267 ++++++++---------- 3 files changed, 187 insertions(+), 197 deletions(-) create mode 100644 src/pages/docs/agent/soft-and-permanent-deletion-of-agents.md delete mode 100644 src/pages/docs/agent/soft-delete-agents.md diff --git a/src/pages/docs/agent/soft-and-permanent-deletion-of-agents.md b/src/pages/docs/agent/soft-and-permanent-deletion-of-agents.md new file mode 100644 index 00000000..9d3999e1 --- /dev/null +++ b/src/pages/docs/agent/soft-and-permanent-deletion-of-agents.md @@ -0,0 +1,67 @@ +--- +title: "Delete Agents: Soft & Permanent" +metadesc: "This article discusses how to soft/permanently delete Testsigma agents & push them to obsolete state & restore these agents when needed | Learn how to soft/permanently delete agents" +noindex: false +order: 11.81 +page_id: "Agent Soft Delete" +warning: false +contextual_links: +- type: section + name: "Contents" +- type: link + name: "Prerequisites" + url: "#prerequisites" +- type: link + name: "Steps to Soft Delete an Agent" + url: "#steps-to-soft-delete-an-agent" +- type: link + name: "Steps to Delete Agents Permanently" + url: "#steps-to-delete-agents-permanently" +--- + +--- + +Managing a long list of Agents can make selecting the right Agent while executing tests difficult. In this scenario, Testsigma lets you push Agents to an obsolete state to hide them from the Agents list page. You can restore/delete these Agents permanently when needed. This article discusses how to soft/permanently delete Agents in Testsigma. + + +--- + +## **Prerequisites** + +- You should have [registered agents](https://testsigma.com/docs/agent/setup-on-windows-mac-linux/#register-the-testsigma-agent) on Testsigma. + +--- + +## **Steps to Soft Delete an Agent** + +1. From the dashboard, go to **Agents**. + +2. Hover over the agent you want to soft delete (push to an obsolete state). + +3. In the warning dialog, click **Obsolete Agent**. + +4. The agent will move to the obsolete state. + +[[info | **NOTE**:]] +| - You can restore an obsolete agent by navigating to **Agents > Obsolete Agent** and clicking Restore. +| - An agent in the obsolete state will not allow the user to execute tests. + + +Here’s a quick GIF demonstrating how to soft delete and restore the obsoleted agent. + + ![Soft Delete Agents](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/SoftDeleteAgent.gif) + +--- + +## **Steps to Delete Agents Permanently** + +1. Navigate from the dashboard to **Agents > Obsolete Agent**. + +2. Click on the kebab menu and select **Delete Permanently**. This will open a warning dialog. + +3. In the warning dialog, confirm deletion by clicking **Delete Permanently**. + + ![Delete Permanently](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/DeleteAgentsPermanently.gif) + + +--- \ No newline at end of file diff --git a/src/pages/docs/agent/soft-delete-agents.md b/src/pages/docs/agent/soft-delete-agents.md deleted file mode 100644 index dedd65d7..00000000 --- a/src/pages/docs/agent/soft-delete-agents.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "Soft Delete Agents" -metadesc: "This article discusses how to soft delete Testsigma agents & push them to obsolete state and restore these agents when needed | Learn how to soft delete Testsigma agents" -noindex: false -order: 11.81 -page_id: "Agent Soft Delete" -warning: false -contextual_links: -- type: section - name: "Contents" -- type: link - name: "Prerequisites" - url: "#prerequisites" -- type: link - name: "Steps to Soft Delete an Agent" - url: "#steps-to-soft-delete-an-agent" ---- - ---- - -Testsigma lets you push agents to an obsolete state, to hide them from the agents list page. You can restore these agents when needed. This article discusses how to soft delete an agent in Testsigma. - ---- - -## **Prerequisites** - -- You should have [registered agents](https://testsigma.com/docs/agent/setup-on-windows-mac-linux/#register-the-testsigma-agent) on Testsigma. - ---- - -## **Steps to Soft Delete an Agent** - -1. From the dashboard, go to **Agents**. - -2. Hover over the agent you want to soft delete (push to an obsolete state). - -3. In the warning dialog, click **Obsolete Agent**. - -4. The agent will move to the obsolete state. - -[[info | **NOTE**:]] -| - You can restore an obsolete agent by navigating to **Agents > Obsolete Agent** and clicking Restore. -| - An agent in the obsolete state will not allow the user to execute tests. - - -Here’s a quick GIF demonstrating how to soft delete and restore the obsoleted agent. - -![Soft Delete Agents](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/SoftDeleteAgent.gif) - ---- diff --git a/src/pages/docs/api/test-results-at-all-levels.md b/src/pages/docs/api/test-results-at-all-levels.md index 2d79c2a1..cd063576 100644 --- a/src/pages/docs/api/test-results-at-all-levels.md +++ b/src/pages/docs/api/test-results-at-all-levels.md @@ -13,20 +13,20 @@ contextual_links: name: "Prerequisites" url: "#prerequisites" - type: link - name: "Fetch Test Plan Details" - url: "#fetch-test-plan-details" + name: "Fetch Test Plan Results" + url: "#fetch-test-plan-results" - type: link - name: "Fetch Test Machine Details" - url: "#fetch-test-machine-details" + name: "Fetch Test Machine Results" + url: "#fetch-test-machine-results" - type: link - name: "Fetch Test Suite Details" - url: "#fetch-test-suite-details" + name: "Fetch Test Suite Results" + url: "#fetch-test-suite-results" - type: link - name: "Fetch Test Case Details" - url: "#fetch-test-case-details" + name: "Fetch Test Case Results" + url: "#fetch-test-case-results" - type: link - name: "Fetch Test Step Details" - url: "#fetch-test-step-details" + name: "Fetch Test Step Results" + url: "#fetch-test-step-results" --- --- @@ -39,196 +39,169 @@ You can leverage Testsigma APIs to fetch detailed test results at all levels. Wh ## **Prerequisites** - You should have an API Key. See, [generate API Keys in Testsigma](https://testsigma.com/docs/configuration/api-keys/). -- You should have a [Test Plan Run ID](https://testsigma.com/docs/api/test-plans/#obtaining-the-run-id) +- You should have a [test plan run ID](https://testsigma.com/docs/api/test-plans/#obtaining-the-run-id). --- -## **Fetch Test Plan Details** +## **Fetch Test Plan Results** + +### **Index for Fetching Test Run Results:** + +> **URL:** +> +> ```https://app.testsigma.com/api/v3/test_runs/``` +> +> **TYPE:** GET +> +> **TS_QUERY:** <parameter><operator><value> chained with , (ex: query=testPlanId:1,result:PASSED) +> +> **Operators:**
+> - : = EQUAL
+> - ! = NOT EQUAL
+> - > = GREATER THAN
+> - < = LESS THAN
+> - ~ = LIKE
+> - @ = IN
+> - ; = NOT IN
+> - $ = CONTAINS
+> +> **STATUS:** 200/401/500/400 +> +> **Pagination:** { page: , pageSize: , isLast: , totalElements: } + + | **Request Type** | **GET** | |----------|----------| | **Endpoint** | ```https://app.testsigma.com/api/v3/test_runs/``` | | **Authorization** | Bearer Token | | **Response Body Type** | JSON | -| **Response Body** | {
"id": 517,
"testPlanId": 420,
"buildNo": null,
"result": "FAILURE",
"startTime": "2024-05-29T07:29:19Z",
"endTime": "2024-05-29T07:33:17Z",
"duration": 238000,
"executor": "bharath.k@testsigma.com",
"triggeredType": "MANUAL",
"metrics": {
"id": 162,
"testPlanResultId": 517,
"totalCount": 8,
"failedCount": 4,
"passedCount": 4,
"stoppedCount": 0,
"notExecutedCount": 0,
"queuedCount": 0,
"runningCount": 0,
"consolidatedPlanTotalCount": 8,
"consolidatedPlanFailedCount": 4,
"consolidatedPlanPassedCount": 4,
"consolidatedPlanStoppedCount": 0,
"consolidatedPlanNotExecutedCount": 0,
"consolidatedPlanQueuedCount": 0,
"consolidatedPlanRunningCount": 0,
"result": "FAILURE",
"latestResult": "FAILURE",
"duration": 226000,
"consolidatedDuration": 226000
}
} | +| **Response Body (Sample)** | {
  "id": 517,
  "testPlanId": 420,
  "buildNo": "run69",
  "result": "FAILURE",
  "startTime": "2024-05-29T07:29:19Z",
  "endTime": "2024-05-29T07:33:17Z",
  "duration": 238000,
  "executor": "bharath.k@testsigma.com",
  "triggeredType": "MANUAL",
  "metrics": {
    "id": 162,
    "testPlanResultId": 517,
    "totalCount": 8,
    "failedCount": 4,
    "passedCount": 4,
    "stoppedCount": 0,
    "notExecutedCount": 0,
    "queuedCount": 0,
    "runningCount": 0,
    "consolidatedPlanTotalCount": 8,
    "consolidatedPlanFailedCount": 4,
    "consolidatedPlanPassedCount": 4,
    "consolidatedPlanStoppedCount": 0,
    "consolidatedPlanNotExecutedCount": 0,
    "consolidatedPlanQueuedCount": 0,
    "consolidatedPlanRunningCount": 0,
    "result": "FAILURE",
    "latestResult": "FAILURE",
    "duration": 226000,
    "consolidatedDuration": 226000
  }
} | In the response body above, we fetched the test plan results with ID 517. -
- -**INDEX:** - -``` -URL: /api/v2/test_runs?query=&page= -TYPE: GET -TS_QUERY: chained with , (ex: query=testPlanId:1,result:PASSED) - -operator: - -: = EQUAL -! = NOT EQUAL -> = GRATER THAN -< = LESS THAN -~ = LIKE -@ = IN -; = NOT IN -$ = CONTAINS - -STATUS: 200/401/500/400 - -pagination: { page: , pageSize: , isLast: , totalElements: } - -``` - --- -## **Fetch Test Machine Details** - +## **Fetch Test Machine Results** + +### **Index for Fetching Test Machine Results:** + +> **URL:** +> +> ```https://app.testsigma.com/api/v3/test_runs//test_machine_results/``` +> +> **TYPE:** GET +> +> **TS_QUERY:** <parameter><operator><value> chained with , (ex: query=testPlanId:1,result:PASSED) +> +> **Operators:**
+> - : = EQUAL
+> - ! = NOT EQUAL
+> - > = GREATER THAN
+> - < = LESS THAN
+> - ~ = LIKE
+> - @ = IN
+> - ; = NOT IN
+> - $ = CONTAINS
+> +> **STATUS:** 200/401/500/400 +> +> **Pagination:** { page: , pageSize: , isLast: , totalElements: } | **Request Type** | **GET** | |----------|----------| | **Endpoint** | ```https://app.testsigma.com/api/v3/test_runs//test_machine_results/``` | | **Authorization** | Bearer Token | | **Response Body Type** | JSON | -| **Response Body** | {
"id": 1434,
"testRunId": 517,
"result": "FAILURE",
"startTime": "2024-05-29T07:29:19Z",
"endTime": "2024-05-29T07:31:40Z",
"duration": 141000,
"deviceConfiguration": {
"title": "Windows Chrome",
"osVersion": "11",
"browser": "GoogleChrome",
"browserVersion": "123.0",
"resolution": "1920x1080",
"platform": "Windows",
"deviceName": null,
"hostName": "agent.testsigma.com",
"osType": "WINDOWS"
},
"metrics": {
"id": 165,
"testDeviceResultId": 1434,
"testPlanResultId": 517,
"totalCount": 4,
"failedCount": 2,
"passedCount": 2,
"stoppedCount": 0,
"notExecutedCount": 0,
"queuedCount": 0,
"runningCount": 0,
"consolidatedTotalCount": 4,
"consolidatedFailedCount": 2,
"consolidatedPassedCount": 2,
"consolidatedStoppedCount": 0,
"consolidatedNotExecutedCount": 0,
"consolidatedQueuedCount": 0,
"consolidatedRunningCount": 0,
"result": "FAILURE",
"latestResult": "FAILURE",
"duration": 129000,
"consolidatedDuration": 129000
},
"appDetails": null
} | +| **Response Body (Sample)** | {
  "id": 1434,
  "testRunId": 517,
  "result": "FAILURE",
  "startTime": "2024-05-29T07:29:19Z",
  "endTime": "2024-05-29T07:31:40Z",
  "duration": 141000,
  "deviceConfiguration": {
    "title": "Windows Chrome",
    "osVersion": "11",
    "browser": "GoogleChrome",
    "browserVersion": "123.0",
    "resolution": "1920x1080",
    "platform": "Windows",
    "deviceName": null,
    "hostName": "agent.testsigma.com",
    "osType": "WINDOWS"
  },
  "metrics": {
    "id": 165,
    "testDeviceResultId": 1434,
    "testPlanResultId": 517,
    "totalCount": 4,
    "failedCount": 2,
    "passedCount": 2,
    "stoppedCount": 0,
    "notExecutedCount": 0,
    "queuedCount": 0,
    "runningCount": 0,
    "consolidatedTotalCount": 4,
    "consolidatedFailedCount": 2,
    "consolidatedPassedCount": 2,
    "consolidatedStoppedCount": 0,
    "consolidatedNotExecutedCount": 0,
    "consolidatedQueuedCount": 0,
    "consolidatedRunningCount": 0,
    "result": "FAILURE",
    "latestResult": "FAILURE",
    "duration": 129000,
    "consolidatedDuration": 129000
  },
  "appDetails": null
} | In the response body above, we fetched the test machine results with ID 1434. -**INDEX:** - -``` -URL: /api/v2/test_runs/{run_id}/test_machine_results?query=&page= -TYPE: GET -TS_QUERY: chained with , (ex: query=result:PASSED) - -operator: - -: = EQUAL -! = NOT EQUAL -> = GRATER THAN -< = LESS THAN -~ = LIKE -@ = IN -; = NOT IN -$ = CONTAINS - -STATUS: 200/401/500/400 - -pagination: { page: , pageSize: , isLast: , totalElements: } - -``` - --- -## **Fetch Test Suite Details** +## **Fetch Test Suite Results** + +### **Index for Fetching Test Suite Results:** + +> **URL:** ```https://app.testsigma.com/api/v3/test_runs//test_suite_results/``` +> +> **TYPE:** GET +> +> **TS_QUERY:** <parameter><operator><value> chained with , (ex: query=testPlanId:1,result:PASSED) +> +> **Operators:**
+> - : = EQUAL
+> - ! = NOT EQUAL
+> - > = GREATER THAN
+> - < = LESS THAN
+> - ~ = LIKE
+> - @ = IN
+> - ; = NOT IN
+> - $ = CONTAINS
+> +> **STATUS:** 200/401/500/400 +> +> **Pagination:** { page: , pageSize: , isLast: , totalElements: } | **Request Type** | **GET** | |----------|----------| -| **Endpoint** | ```https://app.testsigma.com/api/v3/test_runs//test_suite_results/``` | +| **Endpoint** | ```https://app.testsigma.com/api/v3/test_runs//test_suite_results/``` | | **Authorization** | Bearer Token | | **Response Body Type** | JSON | -| **Response Body** | {
"id": 1383,
"suiteId": 359,
"testRunId": 517,
"testMachineRunId": 1434,
"startTime": "2024-05-29T07:29:19Z",
"endTime": "2024-05-29T07:30:33Z",
"duration": 74000,
"result": "FAILURE",
"metrics": {
"id": 293,
"testSuiteResultId": 1383,
"testDeviceResultId": 1434,
"testPlanResultId": 517,
"totalCount": 2,
"failedCount": 1,
"passedCount": 1,
"stoppedCount": 0,
"notExecutedCount": 0,
"queuedCount": 0,
"runningCount": 0,
"consolidatedTotalCount": 2,
"consolidatedFailedCount": 1,
"consolidatedPassedCount": 1,
"consolidatedStoppedCount": 0,
"consolidatedNotExecutedCount": 0,
"consolidatedQueuedCount": 0,
"consolidatedRunningCount": 0,
"result": "FAILURE",
"latestResult": "FAILURE",
"duration": 62000,
"consolidatedDuration": 62000
}
} | +| **Response Body (Sample)** | {
  "id": 1383,
  "testRunId": 517,
  "result": "FAILURE",
  "startTime": "2024-05-29T07:29:19Z",
  "endTime": "2024-05-29T07:30:33Z",
  "duration": 74000,
  "deviceConfiguration": null,
  "metrics": {
    "id": 293,
    "testDeviceResultId": 1434,
    "testPlanResultId": 517,
    "totalCount": 2,
    "failedCount": 1,
    "passedCount": 1,
    "stoppedCount": 0,
    "notExecutedCount": 0,
    "queuedCount": 0,
    "runningCount": 0,
    "consolidatedTotalCount": 2,
    "consolidatedFailedCount": 1,
    "consolidatedPassedCount": 1,
    "consolidatedStoppedCount": 0,
    "consolidatedNotExecutedCount": 0,
    "consolidatedQueuedCount": 0,
    "consolidatedRunningCount": 0,
    "result": "FAILURE",
    "latestResult": "FAILURE",
    "duration": 62000,
    "consolidatedDuration": 62000
  },
  "appDetails": null
} | In the response body above, we fetched the test suite results with ID 1383. - -**INDEX:** - -``` -URL: /api/v2/test_runs/{run_id}/test_suite_results?query=&page= -TYPE: GET -TS_QUERY: chained with , (ex: query=result:PASSED) - -operator: - -: = EQUAL -! = NOT EQUAL -> = GRATER THAN -< = LESS THAN -~ = LIKE -@ = IN -; = NOT IN -$ = CONTAINS - -STATUS: 200/401/500/400 - -pagination: { page: , pageSize: , isLast: , totalElements: } - -``` - --- -## **Fetch Test Case Details** +## **Fetch Test Case Results** + +### **Index for Fetching Test Case Results:** + +> **URL:** +> +> ```https://app.testsigma.com/api/v3/test_runs//test_case_results/``` +> +> **TYPE:** GET +> +> **TS_QUERY:** <parameter><operator><value> chained with , (ex: query=testPlanId:1,result:PASSED) +> +> **Operators:**
+> - : = EQUAL
+> - ! = NOT EQUAL
+> - > = GREATER THAN
+> - < = LESS THAN
+> - ~ = LIKE
+> - @ = IN
+> - ; = NOT IN
+> - $ = CONTAINS
+> +> **STATUS:** 200/401/500/400 +> +> **Pagination:** { page: , pageSize: , isLast: , totalElements: } + | **Request Type** | **GET** | |----------|----------| | **Endpoint** | ```https://app.testsigma.com/api/v3/test_runs//test_case_results/``` | | **Authorization** | Bearer Token | | **Response Body Type** | JSON | -| **Response Body** | {
"id": 3857,
"testCaseId": 609,
"startTime": "2024-05-29T07:29:31Z",
"endTime": "2024-05-29T07:29:55Z",
"duration": 23038,
"result": "FAILURE",
"isDisabled": false,
"isDataDriven": false,
"metrics": {
"id": 1089,
"testCaseResultId": 3857,
"testSuiteResultId": 1383,
"testDeviceResultId": 1434,
"testPlanResultId": 517,
"totalCount": 6,
"failedCount": 1,
"passedCount": 3,
"stoppedCount": 0,
"notExecutedCount": 2,
"queuedCount": 0,
"skippedCount": 0,
"runningCount": 0,
"result": "FAILURE",
"latestResult": "FAILURE",
"duration": 23038,
"consolidatedDuration": 23038
}
} | +| **Response Body (Sample)** | {
  "id": 3857,
  "testCaseId": 609,
  "startTime": "2024-05-29T07:29:31Z",
  "endTime": "2024-05-29T07:29:55Z",
  "duration": 23038,
  "result": "FAILURE",
  "isDisabled": false,
  "isDataDriven": false,
  "metrics": {
    "id": 1089,
    "testCaseResultId": 3857,
    "testSuiteResultId": 1383,
    "testDeviceResultId": 1434,
    "testPlanResultId": 517,
    "totalCount": 6,
    "failedCount": 1,
    "passedCount": 3,
    "stoppedCount": 0,
    "notExecutedCount": 2,
    "queuedCount": 0,
    "skippedCount": 0,
    "runningCount": 0,
    "result": "FAILURE",
    "latestResult": "FAILURE",
    "duration": 23038,
    "consolidatedDuration": 23038
  },
  "appDetails": null
} | In the response body above, we fetched the test case results with ID 3857. -**INDEX:** - -``` -URL: /api/v2/test_runs/{run_id}/test_case_results?query=&page= -TYPE: GET -TS_QUERY: chained with , (ex: query=result:PASSED) - -operator: - -: = EQUAL -! = NOT EQUAL -> = GRATER THAN -< = LESS THAN -~ = LIKE -@ = IN -; = NOT IN -$ = CONTAINS - -STATUS: 200/401/500/400 - -pagination: { page: , pageSize: , isLast: , totalElements: } - -``` - --- -## **Fetch Test Step Details** - +## **Fetch Test Step Results** | **Request Type** | **GET** | |----------|----------| -| **Endpoint** | ```https://app.testsigma.com/api/v3/test_runs//test_case_results//step_results/``` | +| **Endpoint** | ```https://app.testsigma.com/api/v3/test_runs//test_case_results//step_results``` | | **Authorization** | Bearer Token | | **Response Body Type** | JSON | -| **Response Body** | {
"content": [
{ "id": "3c51e933-7e15-41a0-893b-38e38b8258a2",
"testMachineResultId": 1434,
"testCaseResultId": 3857,
"testCaseId": 609,
"stepId": 2847,
"type": "NLP\_TEXT",
"action": "Navigate to https://simply-travel.testsigma.com/",
"message": "Successfully opened given URL.",
"errorCode": null,
"errorType": null,
"result": "SUCCESS",
"conditionalResult": null,
"visualTestResult": null,
"startTime": "2024-05-29T07:29:32Z",
"endTime": "2024-05-29T07:29:33Z",
"duration": 1133,
"visualEnabled": false },
{ "id": "c3a8fbeb-b508-41d2-83f7-6a0ca152e234",
"testMachineResultId": 1434,
"testCaseResultId": 3857,
"testCaseId": 609,
"stepId": 2848,
"type": "NLP\_TEXT",
"action": "Click on Login or Sign Up Button",
"message": "Successfully performed click action.",
"errorCode": null,
"errorType": null,
"result": "SUCCESS",
"conditionalResult": null,
"visualTestResult": null,
"startTime": "2024-05-29T07:29:37Z",
"endTime": "2024-05-29T07:29:39Z",
"duration": 2040,
"visualEnabled": false },
{ "id": "36bbdc50-ca05-4289-8342-c9e20d0491a4",
"testMachineResultId": 1434,
"testCaseResultId": 3857,
"testCaseId": 609,
"stepId": 2849,
"type": "NLP\_TEXT",
"action": "Click on Login Button",
"message": "Successfully performed click action.",
"errorCode": null,
"errorType": null,
"result": "SUCCESS",
"conditionalResult": null,
"visualTestResult": null,
"startTime": "2024-05-29T07:29:42Z",
"endTime": "2024-05-29T07:29:44Z",
"duration": 1539,
"visualEnabled": false },
{ "id": "abefa297-cb14-48f4-b9e8-60db12854c03",
"testMachineResultId": 1434,
"testCaseResultId": 3857,
"testCaseId": 609,
"stepId": 2850,
"type": "NLP\_TEXT",
"action": "Select the radio button Mobile Number Radio Button",
"message": "Unable to perform click/check action on element, Element is not displayed.",
"errorCode": 1000001,
"errorType": "ASSERT\_ERROR",
"result": "FAILURE",
"conditionalResult": null,
"visualTestResult": null,
"startTime": "2024-05-29T07:29:47Z",
"endTime": "2024-05-29T07:29:51Z",
"duration": 3803,
"visualEnabled": false },
{ "id": "49b04ef4-40fa-476f-b2a7-17d7a6e68230",
"testMachineResultId": 1434,
"testCaseResultId": 3857,
"testCaseId": 609,
"stepId": 2851,
"type": "NLP\_TEXT",
"action": "Enter 9876543212 in the Mobile Number Radio Button field",
"message": "Major Test step failed .",
"errorCode": null,
"errorType": null,
"result": "NOT\_EXECUTED",
"conditionalResult": null,
"visualTestResult": null,
"startTime": "2024-05-29T07:29:54Z",
"endTime": "2024-05-29T07:29:54Z",
"duration": 1,
"visualEnabled": false },
{ "id": "0a2c386f-5639-4276-b69e-f8715cd7a85c",
"testMachineResultId": 1434,
"testCaseResultId": 3857,
"testCaseId": 609,
"stepId": 2852,
"type": "NLP\_TEXT",
"action": "Click on Continue Button",
"message": "Major Test step failed .",
"errorCode": null,
"errorType": null,
"result": "NOT\_EXECUTED",
"conditionalResult": null,
"visualTestResult": null,
"startTime": "2024-05-29T07:29:54Z",
"endTime": null,
"duration": 0,
"visualEnabled": false }
],
"totalElements": null,
"totalPages": 1,
"pageable": null,
"last": false,
"numberOfElements": 6,
"first": true,
"sort": null,
"number": 0,
"size": 100,
"empty": false,
} | +| **Response Body (Sample)** | {
  "content": [
  { "id": "3c51e933-7e15-41a0-893b-38e38b8258a2",
    "testMachineResultId": 1434,
    "testCaseResultId": 3857,
    "testCaseId": 609,
    "stepId": 2847,
    "type": "NLP_TEXT",
    "action": "Navigate to https://simply-travel.testsigma.com/",
    "message": "Successfully opened given URL.",
    "errorCode": null,
    "errorType": null,
    "result": "SUCCESS",
    "conditionalResult": null,
    "visualTestResult": null,
    "startTime": "2024-05-29T07:29:32Z",
    "endTime": "2024-05-29T07:29:33Z",
    "duration": 1133,
    "visualEnabled": false },
  { "id": "c3a8fbeb-b508-41d2-83f7-6a0ca152e234",
    "testMachineResultId": 1434,
    "testCaseResultId": 3857,
    "testCaseId": 609,
    "stepId": 2848,
    "type": "NLP_TEXT",
    "action": "Click on Login or Sign Up Button",
    "message": "Successfully performed click action.",
    "errorCode": null,
    "errorType": null,
    "result": "SUCCESS",
    "conditionalResult": null,
    "visualTestResult": null,
    "startTime": "2024-05-29T07:29:37Z",
    "endTime": "2024-05-29T07:29:39Z",
    "duration": 2040,
    "visualEnabled": false },
  { "id": "36bbdc50-ca05-4289-8342-c9e20d0491a4",
    "testMachineResultId": 1434,
    "testCaseResultId": 3857,
    "testCaseId": 609,
    "stepId": 2849,
    "type": "NLP_TEXT",
    "action": "Click on Login Button",
    "message": "Successfully performed click action.",
    "errorCode": null,
    "errorType": null,
    "result": "SUCCESS",
    "conditionalResult": null,
    "visualTestResult": null,
    "startTime": "2024-05-29T07:29:42Z",
    "endTime": "2024-05-29T07:29:44Z",
    "duration": 1539,
    "visualEnabled": false },
  { "id": "abefa297-cb14-48f4-b9e8-60db12854c03",
    "testMachineResultId": 1434,
    "testCaseResultId": 3857,
    "testCaseId": 609,
    "stepId": 2850,
    "type": "NLP_TEXT",
    "action": "Select the radio button Mobile Number Radio Button",
    "message": "Unable to perform click/check action on element, Element is not displayed.",
    "errorCode": 1000001,
    "errorType": "ASSERT_ERROR",
    "result": "FAILURE",
    "conditionalResult": null,
    "visualTestResult": null,
    "startTime": "2024-05-29T07:29:47Z",
    "endTime": "2024-05-29T07:29:51Z",
    "duration": 3803,
    "visualEnabled": false },
  { "id": "49b04ef4-40fa-476f-b2a7-17d7a6e68230",
    "testMachineResultId": 1434,
    "testCaseResultId": 3857,
    "testCaseId": 609,
    "stepId": 2851,
    "type": "NLP_TEXT",
    "action": "Enter 9876543212 in the Mobile Number Radio Button field",
    "message": "Major Test step failed.",
    "errorCode": null,
    "errorType": null,
    "result": "NOT_EXECUTED",
    "conditionalResult": null,
    "visualTestResult": null,
    "startTime": "2024-05-29T07:29:54Z",
    "endTime": "2024-05-29T07:29:54Z",
    "duration": 1,
    "visualEnabled": false },
  { "id": "0a2c386f-5639-4276-b69e-f8715cd7a85c",
    "testMachineResultId": 1434,
    "testCaseResultId": 3857,
    "testCaseId": 609,
    "stepId": 2852,
    "type": "NLP_TEXT",
    "action": "Click on Continue Button",
    "message": "Major Test step failed.",
    "errorCode": null,
    "errorType": null,
    "result": "NOT_EXECUTED",
    "conditionalResult": null,
    "visualTestResult": null,
    "startTime": "2024-05-29T07:29:54Z",
    "endTime": null,
    "duration": 0,
    "visualEnabled": false }
  ],
  "totalElements": null,
  "totalPages": 1,
  "pageable": null,
  "last": false,
  "numberOfElements": 6,
  "first": true,
  "sort": null,
  "number": 0,
  "size": 100,
  "empty": false
} | In the response body above, we fetched the test step results of a test case with result ID 3857. -**INDEX:** - -``` -URL: /api/v2/test_runs/{run_id}/test_case_results/{case_result_id}/step_results?query=&page= -TYPE: GET -TS_QUERY: chained with , (ex: query=result:PASSED) - -operator: - -: = EQUAL -! = NOT EQUAL -> = GRATER THAN -< = LESS THAN -~ = LIKE -@ = IN -; = NOT IN -$ = CONTAINS - -STATUS: 200/401/500/400 - -pagination: { page: , pageSize: , isLast: , totalElements: } - -``` --- \ No newline at end of file