Jump to

• Request
• Response

Create test runs

post

https://{your_site_interface}/opa-hub/api/12.2.35/tests/{test-suite-name}/runs

This operation will create test runs.

Request

Path Parameters

• test-suite-name(required): string
  The name of the test suite to be retrieved.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/testRunPost"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object testRunPost

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/testRunPost"
    }
}

Nested Schema : testRunPost

Type: object

Show Source

• type(required): string
  The type of this test run.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"The type of this test run."
        }
    },
    "additionalProperties":false,
    "required":[
        "type"
    ]
}

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

201 Response

The request has been fulfilled and resulted in a new resource being created.

Body ()

Root Schema : testRuns

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/testRun"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object testRun

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/testRun"
    }
}

Nested Schema : testRun

Type: object

Show Source

• deployments: object testRunDeployments
• projects: object testRunProjects
• runNumber: number (double)
  Read Only: true

  The identity number of the test run.
• status: string
  The status of this test run.
• summary: object testRunSummary
• type: string
  The type of this test run.

{
    "type":"object",
    "properties":{
        "runNumber":{
            "type":"number",
            "format":"double",
            "description":"The identity number of the test run.",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "description":"The type of this test run."
        },
        "status":{
            "type":"string",
            "description":"The status of this test run."
        },
        "deployments":{
            "$ref":"#/components/schemas/testRunDeployments"
        },
        "projects":{
            "$ref":"#/components/schemas/testRunProjects"
        },
        "summary":{
            "description":"The results summary of the test run.",
            "readOnly":true,
            "$ref":"#/components/schemas/testRunSummary"
        }
    },
    "additionalProperties":false
}

Nested Schema : testRunDeployments

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/testRunDeployment"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : testRunProjects

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/testRunProject"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : testRunSummary

Type: object

Show Source

• error: number (double)
  The number of tests that encountered and error for the test run.
• failed: number (double)
  The number of tests that have failed for the test run.
• passed: number (double)
  The number of tests that have passed for the test run.
• pending: number (double)
  The number of tests that are pending for the test run.
• total: number (double)
  The total number of tests for the test run.

{
    "type":"object",
    "properties":{
        "total":{
            "type":"number",
            "format":"double",
            "description":"The total number of tests for the test run."
        },
        "passed":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that have passed for the test run."
        },
        "failed":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that have failed for the test run."
        },
        "error":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that encountered and error for the test run."
        },
        "pending":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that are pending for the test run."
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object testRunDeployment

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/testRunDeployment"
    }
}

Nested Schema : testRunDeployment

Type: object

Show Source

• name: string
  Read Only: true

  The name of the tested deployment.
• results: object testRunDeploymentResults
• summary: object testRunDeploymentSummary
• version: number (double)
  Read Only: true

  The version of the tested deployment.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the tested deployment.",
            "readOnly":true
        },
        "version":{
            "type":"number",
            "format":"double",
            "description":"The version of the tested deployment.",
            "readOnly":true
        },
        "results":{
            "$ref":"#/components/schemas/testRunDeploymentResults"
        },
        "summary":{
            "description":"The results summary of the tested deployment.",
            "readOnly":true,
            "$ref":"#/components/schemas/testRunDeploymentSummary"
        }
    },
    "additionalProperties":false
}

Nested Schema : testRunDeploymentResults

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/testCaseResult"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : testRunDeploymentSummary

Type: object

Show Source

• error: number (double)
  The number of tests that encountered and error for the tested deployment.
• failed: number (double)
  The number of tests that have failed for the tested deployment.
• passed: number (double)
  The number of tests that have passed for the tested deployment.
• pending: number (double)
  The number of tests that are pending for the tested deployment.
• total: number (double)
  The total number of tests for the tested deployment.

{
    "type":"object",
    "properties":{
        "total":{
            "type":"number",
            "format":"double",
            "description":"The total number of tests for the tested deployment."
        },
        "passed":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that have passed for the tested deployment."
        },
        "failed":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that have failed for the tested deployment."
        },
        "error":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that encountered and error for the tested deployment."
        },
        "pending":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that are pending for the tested deployment."
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object testCaseResult

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/testCaseResult"
    }
}

Nested Schema : testCaseResult

Type: object

Show Source

• actualOutput: object testCaseResultActualOutput
  Additional Properties Allowed: true
• expectedOutput: object testCaseResultExpectedOutput
  Additional Properties Allowed: true
• input: object testCaseResultInput
  Additional Properties Allowed: true
• name: string
  Read Only: true

  The name of the test case result.
• outcome: object testCaseResultOutcome
  Additional Properties Allowed: true
• status: string
  Read Only: true

  The status of the test case result.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the test case result.",
            "readOnly":true
        },
        "status":{
            "type":"string",
            "description":"The status of the test case result.",
            "readOnly":true
        },
        "input":{
            "description":"The input data of the test case result.",
            "readOnly":true,
            "$ref":"#/components/schemas/testCaseResultInput"
        },
        "expectedOutput":{
            "description":"The expected output data of the test case result.",
            "readOnly":true,
            "$ref":"#/components/schemas/testCaseResultExpectedOutput"
        },
        "actualOutput":{
            "description":"The actual output data of the test case result.",
            "readOnly":true,
            "$ref":"#/components/schemas/testCaseResultActualOutput"
        },
        "outcome":{
            "description":"The outcome of the test case result.",
            "readOnly":true,
            "$ref":"#/components/schemas/testCaseResultOutcome"
        }
    },
    "additionalProperties":false
}

Nested Schema : testCaseResultActualOutput

Type: object

Additional Properties Allowed: true

Nested Schema : testCaseResultExpectedOutput

Type: object

Additional Properties Allowed: true

Nested Schema : testCaseResultInput

Type: object

Additional Properties Allowed: true

Nested Schema : testCaseResultOutcome

Type: object

Additional Properties Allowed: true

Nested Schema : items

Type: array

Show Source

• Array of: object testRunProject

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/testRunProject"
    }
}

Nested Schema : testRunProject

Type: object

Show Source

• name: string
  Read Only: true

  The name of the tested project.
• results: object testRunProjectResults
• summary: object testRunProjectSummary
• version: number (double)
  Read Only: true

  The version of the tested project.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the tested project.",
            "readOnly":true
        },
        "version":{
            "type":"number",
            "format":"double",
            "description":"The version of the tested project.",
            "readOnly":true
        },
        "results":{
            "$ref":"#/components/schemas/testRunProjectResults"
        },
        "summary":{
            "description":"The results summary of the tested project.",
            "readOnly":true,
            "$ref":"#/components/schemas/testRunProjectSummary"
        }
    },
    "additionalProperties":false
}

Nested Schema : testRunProjectResults

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/testCaseResult"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : testRunProjectSummary

Type: object

Show Source

• error: number (double)
  The number of tests that encountered and error for the tested project.
• failed: number (double)
  The number of tests that have failed for the tested project.
• passed: number (double)
  The number of tests that have passed for the tested project.
• pending: number (double)
  The number of tests that are pending for the tested project.
• total: number (double)
  The total number of tests for the tested project.

{
    "type":"object",
    "properties":{
        "total":{
            "type":"number",
            "format":"double",
            "description":"The total number of tests for the tested project."
        },
        "passed":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that have passed for the tested project."
        },
        "failed":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that have failed for the tested project."
        },
        "error":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that encountered and error for the tested project."
        },
        "pending":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that are pending for the tested project."
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object testCaseResult

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/testCaseResult"
    }
}

400 Response

The request could not be processed because it contains missing or invalid information.

409 Response

The request could not be completed due to a conflict with the current state of the resource.

Back to Top