TestSuites

Run multiple TestSuites by query

Executes all TestSuites impacted by the specified filter. Requires TEST permission with the CREATE action.

post/api/v1/{tenant}/tests/run

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/{tenant}/tests/run
  • Auth: none declared

Path parameters

tenantstring required

Request body

namespacestring nullable
flowIdstring nullable
includeChildNamespacesboolean required

Should child namespaces be included or not

Example request

{
  "namespace": "namespace",
  "flowId": "flowId",
  "includeChildNamespaces": true
}

Response

runTestSuitesByQuery 200 response

tenantIdstring
numberOfTestSuitesToBeRuninteger
numberOfTestCasesToBeRuninteger

Example response

{
  "tenantId": "tenantId",
  "numberOfTestSuitesToBeRun": 0,
  "numberOfTestCasesToBeRun": 6,
  "requestMade": {
    "namespace": "namespace",
    "flowId": "flowId",
    "includeChildNamespaces": true
  },
  "results": [
    {
      "endDate": "2000-01-23T04:56:07.000+00:00",
      "namespace": "namespace",
      "id": "id",
      "testSuiteId": "testSuiteId",
      "state": "ERROR",
      "flowId": "flowId",
      "results": [
        {
          "executionId": "executionId",
          "assertionResults": [
            {
              "actual": "{}",
              "expected": "{}",
              "errorMessage": "errorMessage",
              "description": "description",
              "operator": "operator",
              "taskId": "taskId",
              "isSuccess": true
            },
            {
              "actual": "{}",
              "expected": "{}",
              "errorMessage": "errorMessage",
              "description": "description",
              "operator": "operator",
              "taskId": "taskId",
              "isSuccess": true
            }
          ],
          "testType": "testType",
          "testId": "testId",
          "state": null,
          "url": "https://openapi-generator.tech",
          "errors": [
            {
              "details": "details",
              "message": "message"
            },
            {
              "details": "details",
              "message": "message"
            }
          ],
          "fixtures": {
            "inputs": {
              "key": ""
            },
            "files": {
              "key": "files"
            },
            "trigger": {
              "variables": {
                "key": "{}"
              },
              "id": "id",
              "type": "type"
            },
            "tasks": [
              {
                "outputs": {
                  "key": "{}"
                },
                "assets": [
                  {
                    "metadata": {
                      "key": "{}"
                    },
                    "displayName": "displayName",
                    "namespace": "namespace",
                    "description": "description",
                    "id": "id",
                    "type": "type"
                  },
                  {
                    "metadata": {
                      "key": "{}"
                    },
                    "displayName": "displayName",
                    "namespace": "namespace",
                    "description": "description",
                    "id": "id",
                    "type": "type"
                  }
                ],
                "description": {
                  "expression": "expression",
                  "value": "value"
                },
                "id": "id",
                "state": null,
                "value": "value"
              },
              {
                "outputs": {
                  "key": "{}"
                },
                "assets": [
                  {
                    "metadata": {
                      "key": "{}"
                    },
                    "displayName": "displayName",
                    "namespace": "namespace",
                    "description": "description",
                    "id": "id",
                    "type": "type"
                  },
                  {
                    "metadata": {
                      "key": "{}"
                    },
                    "displayName": "displayName",
                    "namespace": "namespace",
                    "description": "description",
                    "id": "id",
                    "type": "type"
                  }
                ],
                "description": {
                  "expression": "expression",
                  "value": "value"
                },
                "id": "id",
                "state": null,
                "value": "value"
              }
            ]
          }
        },
        {
          "executionId": "executionId",
          "assertionResults": [
            {
              "actual": "{}",
              "expected": "{}",
              "errorMessage": "errorMessage",
              "description": "description",
              "operator": "operator",
              "taskId": "taskId",
              "isSuccess": true
            },
            {
              "actual": "{}",
              "expected": "{}",
              "errorMessage": "errorMessage",
              "description": "description",
              "operator": "operator",
              "taskId": "taskId",
              "isSuccess": true
            }
          ],
          "testType": "testType",
          "testId": "testId",
          "state": null,
          "url": "https://openapi-generator.tech",
          "errors": [
            {
              "details": "details",
              "message": "message"
            },
            {
              "details": "details",
              "message": "message"
            }
          ],
          "fixtures": {
            "inputs": {
              "key": ""
            },
            "files": {
              "key": "files"
            },
            "trigger": {
              "variables": {
                "key": "{}"
              },
              "id": "id",
              "type": "type"
            },
            "tasks": [
              {
                "outputs": {
                  "key": "{}"
                },
                "assets": [
                  {
                    "metadata": {
                      "key": "{}"
                    },
                    "displayName": "displayName",
                    "namespace": "namespace",
                    "description": "description",
                    "id": "id",
                    "type": "type"
                  },
                  {
                    "metadata": {
                      "key": "{}"
                    },
                    "displayName": "displayName",
                    "namespace": "namespace",
                    "description": "description",
                    "id": "id",
                    "type": "type"
                  }
                ],
                "description": {
                  "expression": "expression",
                  "value": "value"
                },
                "id": "id",
                "state": null,
                "value": "value"
              },
              {
                "outputs": {
                  "key": "{}"
                },
                "assets": [
                  {
                    "metadata": {
                      "key": "{}"
                    },
                    "displayName": "displayName",
                    "namespace": "namespace",
                    "description": "description",
                    "id": "id",
                    "type": "type"
                  },
                  {
                    "metadata": {
                      "key": "{}"
                    },
                    "displayName": "displayName",
                    "namespace": "namespace",
                    "description": "description",
                    "id": "id",
                    "type": "type"
                  }
                ],
                "description": {
                  "expression": "expression",
                  "value": "value"
                },
                "id": "id",
                "state": null,
                "value": "value"
              }
            ]
          }
        }
      ],
      "startDate": "2000-01-23T04:56:07.000+00:00"
    },
    {
      "endDate": "2000-01-23T04:56:07.000+00:00",
      "namespace": "namespace",
      "id": "id",
      "testSuiteId": "testSuiteId",
      "state": "ERROR",
      "flowId": "flowId",
      "results": [
        {
          "executionId": "executionId",
          "assertionResults": [
            {
              "actual": "{}",
              "expected": "{}",
              "errorMessage": "errorMessage",
              "description": "description",
              "operator": "operator",
              "taskId": "taskId",
              "isSuccess": true
            },
            {
              "actual": "{}",
              "expected": "{}",
              "errorMessage": "errorMessage",
              "description": "description",
              "operator": "operator",
              "taskId": "taskId",
              "isSuccess": true
            }
          ],
          "testType": "testType",
          "testId": "testId",
          "state": null,
          "url": "https://openapi-generator.tech",
          "errors": [
            {
              "details": "details",
              "message": "message"
            },
            {
              "details": "details",
              "message": "message"
            }
          ],
          "fixtures": {
            "inputs": {
              "key": ""
            },
            "files": {
              "key": "files"
            },
            "trigger": {
              "variables": {
                "key": "{}"
              },
              "id": "id",
              "type": "type"
            },
            "tasks": [
              {
                "outputs": {
                  "key": "{}"
                },
                "assets": [
                  {
                    "metadata": {
                      "key": "{}"
                    },
                    "displayName": "displayName",
                    "namespace": "namespace",
                    "description": "description",
                    "id": "id",
                    "type": "type"
                  },
                  {
                    "metadata": {
                      "key": "{}"
                    },
                    "displayName": "displayName",
                    "namespace": "namespace",
                    "description": "description",
                    "id": "id",
                    "type": "type"
                  }
                ],
                "description": {
                  "expression": "expression",
                  "value": "value"
                },
                "id": "id",
                "state": null,
                "value": "value"
              },
              {
                "outputs": {
                  "key": "{}"
                },
                "assets": [
                  {
                    "metadata": {
                      "key": "{}"
                    },
                    "displayName": "displayName",
                    "namespace": "namespace",
                    "description": "description",
                    "id": "id",
                    "type": "type"
                  },
                  {
                    "metadata": {
                      "key": "{}"
                    },
                    "displayName": "displayName",
                    "namespace": "namespace",
                    "description": "description",
                    "id": "id",
                    "type": "type"
                  }
                ],
                "description": {
                  "expression": "expression",
                  "value": "value"
                },
                "id": "id",
                "state": null,
                "value": "value"
              }
            ]
          }
        },
        {
          "executionId": "executionId",
          "assertionResults": [
            {
              "actual": "{}",
              "expected": "{}",
              "errorMessage": "errorMessage",
              "description": "description",
              "operator": "operator",
              "taskId": "taskId",
              "isSuccess": true
            },
            {
              "actual": "{}",
              "expected": "{}",
              "errorMessage": "errorMessage",
              "description": "description",
              "operator": "operator",
              "taskId": "taskId",
              "isSuccess": true
            }
          ],
          "testType": "testType",
          "testId": "testId",
          "state": null,
          "url": "https://openapi-generator.tech",
          "errors": [
            {
              "details": "details",
              "message": "message"
            },
            {
              "details": "details",
              "message": "message"
            }
          ],
          "fixtures": {
            "inputs": {
              "key": ""
            },
            "files": {
              "key": "files"
            },
            "trigger": {
              "variables": {
                "key": "{}"
              },
              "id": "id",
              "type": "type"
            },
            "tasks": [
              {
                "outputs": {
                  "key": "{}"
                },
                "assets": [
                  {
                    "metadata": {
                      "key": "{}"
                    },
                    "displayName": "displayName",
                    "namespace": "namespace",
                    "description": "description",
                    "id": "id",
                    "type": "type"
                  },
                  {
                    "metadata": {
                      "key": "{}"
                    },
                    "displayName": "displayName",
                    "namespace": "namespace",
                    "description": "description",
                    "id": "id",
                    "type": "type"
                  }
                ],
                "description": {
                  "expression": "expression",
                  "value": "value"
                },
                "id": "id",
                "state": null,
                "value": "value"
              },
              {
                "outputs": {
                  "key": "{}"
                },
                "assets": [
                  {
                    "metadata": {
                      "key": "{}"
                    },
                    "displayName": "displayName",
                    "namespace": "namespace",
                    "description": "description",
                    "id": "id",
                    "type": "type"
                  },
                  {
                    "metadata": {
                      "key": "{}"
                    },
                    "displayName": "displayName",
                    "namespace": "namespace",
                    "description": "description",
                    "id": "id",
                    "type": "type"
                  }
                ],
                "description": {
                  "expression": "expression",
                  "value": "value"
                },
                "id": "id",
                "state": null,
                "value": "value"
              }
            ]
          }
        }
      ],
      "startDate": "2000-01-23T04:56:07.000+00:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 7 revisions of this API.