LiTech Data Observability Help

Test suites

  • API endpoint: /api/v1/testsuites

  • Type: POST

  • Description: Returns test suite info with results

  • Parameters: names

  • Example body:

{ "names": [ "crm", "rfam" ] }

Result:

[ { "id": 4, "name": "CRM", "owner": "John", "lastExecBy": "System", "execTime": "2022-01-21 09:00:28", "execEndTime": "2022-01-21 09:01:39", "duration": "71", "nextExecutionTime": "2022-01-22 09:00:00", "schedule": "Daily / 09:00", "passed": 217, "failed": 24, "error": 29, "notExecuted": 0, "testCount": 270, "directory": "BI/daily", "tags": ["DAILY"] }, { "id": 5, "name": "Rfam", "owner": "John", "lastExecBy": "System", "execTime": "2022-01-21 09:40:30", "execEndTime": "2022-01-21 09:43:33", "duration": "183", "nextExecutionTime": "2022-01-22 04:00:00", "schedule": "Daily / 04:00", "passed": 101, "failed": 16, "error": 1, "notExecuted": 0, "testCount": 118, "directory": null, "tags": [] } ]

Execute

  • API endpoint: /api/v1/testsuites/execute

  • Type: POST

  • Description: Executes test suite and returns results

  • Parameters: name, variables

  • Example body:

{ "name": "bike_store", "variables": { "environment": "STAGING", "countryCode": "EN" } }
  • Result

{ "id": 10, "name": "Bike_store", "owner": "admin", "lastExecBy": "REST", "execTime": "2022-01-21 10:42:26", "execEndTime": "2022-01-21 10:42:26", "duration": "0", "nextExecutionTime": "2022-01-21 16:21:00", "schedule": "Daily / 16:21", "passed": 37, "failed": 0, "error": 0, "notExecuted": 0, "testCount": 37, "directory": "Inventory/Bikes", "tags": ["Bike_store"] }

All

  • API endpoint: /api/v1/testsuites/all

  • Type: GET

  • Description: Returns test suite info with results for all test suites

  • Parameters: none

  • Result:

[ { "id": 27, "name": " Robot_tests", "owner": "admin", "lastExecBy": "admin", "execTime": "2021-12-13 19:04:35", "execEndTime": "2021-12-13 19:04:36", "duration": "1", "nextExecutionTime": "2022-01-21 12:00:00", "schedule": "Workdays / 12:00", "passed": 16, "failed": 0, "error": 1, "notExecuted": 0, "testCount": 17, "directory": "BI/daily", "tags": ["DAILY"] }, { "id": 18, "name": " Ticket_sales", "owner": "admin", "lastExecBy": "admin", "execTime": "2022-01-21 09:55:05", "execEndTime": "2022-01-21 09:55:07", "duration": "2", "nextExecutionTime": "", "schedule": "", "passed": 16, "failed": 1, "error": 0, "notExecuted": 0, "testCount": 17, "directory": null, "tags": [] } ]

Public

  • API endpoint: /api/v1/testsuites/public

  • Type: GET

  • Description: Returns test suite info with results for public test suites

  • Parameters: none

  • Result:

[ { "id": 27, "name": "Robot_tests", "owner": "admin", "lastExecBy": "admin", "execTime": "2021-12-13 19:04:35", "execEndTime": "2021-12-13 19:04:36", "duration": "1", "nextExecutionTime": "2022-01-21 12:00:00", "schedule": "Workdays / 12:00", "passed": 16, "failed": 0, "error": 1, "notExecuted": 0, "testCount": 17, "directory": null, "tags": [] }, { "id": 9, "name": "Classic_models", "owner": "admin", "lastExecBy": "System", "execTime": "2022-01-21 09:39:30", "execEndTime": "2022-01-21 09:40:14", "duration": "44", "nextExecutionTime": "2022-01-22 00:40:14", "schedule": "Every 900 minutes", "passed": 29, "failed": 4, "error": 0, "notExecuted": 0, "testCount": 33, "directory": null, "tags": [] } ]

User

  • API endpoint: /api/v1/testsuites/user

  • Type: POST

  • Description: Returns test suite info with results for users test suites

  • Parameters: names

  • Example body:

{ "names": [ "admin", "John" ] }

Result

[ { "id": 27, "name": " Robot_tests", "owner": "admin", "lastExecBy": "admin", "execTime": "2021-12-13 19:04:35", "execEndTime": "2021-12-13 19:04:36", "duration": "1", "nextExecutionTime": "2022-01-21 12:00:00", "schedule": "Workdays / 12:00", "passed": 16, "failed": 0, "error": 1, "notExecuted": 0, "testCount": 17, "directory": null, "tags": [] }, { "id": 18, "name": " Ticket_sales", "owner": "admin", "lastExecBy": "admin", "execTime": "2022-01-21 09:55:05", "execEndTime": "2022-01-21 09:55:07", "duration": "2", "nextExecutionTime": "", "schedule": "", "passed": 16, "failed": 1, "error": 0, "notExecuted": 0, "testCount": 17, "directory": null, "tags": [] } ]

Tag

  • API endpoint: /api/v1/testsuites/tag

  • Type: POST

  • Description: Returns test suite info with results for tag(s)

  • Parameters: names

  • Example body:

{ "names": [ "live", "aws" ] }
[ { "id": 10, "name": "Bike_store", "owner": "admin", "lastExecBy": "REST", "execTime": "2022-01-21 10:42:26", "execEndTime": "2022-01-21 10:42:26", "duration": "0", "nextExecutionTime": "2022-01-21 16:21:00", "schedule": "Daily / 16:21", "passed": 37, "failed": 0, "error": 0, "notExecuted": 0, "testCount": 37, "directory": "Inventory/Bikes", "tags": [] }, { "id": 11, "name": "Music_data", "owner": "John", "lastExecBy": "System", "execTime": "2022-01-17 12:02:26", "execEndTime": "2022-01-17 12:02:35", "duration": "9", "nextExecutionTime": "2022-01-24 10:00:00", "schedule": "Mondays / 10:00", "passed": 107, "failed": 24, "error": 26, "notExecuted": 0, "testCount": 157, "directory": null, "tags": [] } ]
Last modified: 18 March 2024