Jump to

• Request
• Response
• Examples

Run Automation

post

/taas/runAutomationJob

Runs the automation job.

Request

There are no request parameters for this operation.

Back to Top

Response

Default Response

Sets the default response.

Back to Top

Examples

The following example shows how to run an automation job by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".

The -d option specifies the file to attach as the request body.

curl -X POST "hostname:port/runAutomationJob" -H "accept: */*" -H "Content-Type: application/json" -d @file.json

where:

• file.json is the JSON file with the job details to run.

Example of Request Body

The following is an example of the contents of file.json sent as the request body:

{
  "name" : "TodoJob",
  "executionConfig" : {
      "name": "Sample Execution Job",
      "execution": "serial",
      "group": [{
          "name": "test",
          "execution": "serial",
          "scenarios": [
             "ToDo-E2E-Automation",
              "ToDo-FunctionsAndOperators"
          ]
      }]
  }
  "environment" : [
      {
          "name" : "todo",
          "type" : "api.rest",
         "hostname"  : "hostname",
          "url" : "URL",
          "authorization" : "YES",
          "authorization.type" : "basic",
          "basic.username" : "[e-mail]",
          "basic.password" : "password"
      }
  ],
  "callBack":{
      "name":"callback",
          "url":"HostNamek",
          "authorize":true,
          "authorization":{
                      "type":"BASIC",
                      "basic": {
                                  "username": "[e-mail]",
                                  "password": "password"
          }
      }
  }
} 

Example of Response Body

If successful, the response code 200 is returned along with a header. For example:

{
    "Status": "In-progress",
    "Job-Execution-ID": "TodoJob_1760332645939"
}

If the request fails, the response includes the appropriate HTTP code. For a 4xx/5xx code, the message body also contains a ProblemDetails structure with the cause attribute set to the appropriate application error.

Back to Top