The post start automation task operation start a preconfigured task with the specified parameters. The task can be started via the task GUID. In addition optional variables can be passed to alter the pre-configured available variables within the task.
Request
Request URI
| Method | Request URI |
|---|---|
| POST | https://{company-name}.helloid.com/api/v1/automation/tasks/{taskGuid}/start |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {taskGUID} | The task guid of the task you want to start. |
Request headers
| Header | Description |
|---|---|
| Content-Type | Required. Must be set to application/json. |
Sample request body
[
{
"name": "Variable name here",
"value": "Variable value here"
}
]
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful. |
| 404(NOT FOUND) | Indicates that the operation was not successful. No group was found. |
| 400(BAD REQUEST) | Indicates that the operation was not successful. There were validation errors or the request body was malformed. |
| 401(UNAUTHORIZED) | Indicates that no authentication header was given or the api key and secret were invalid. If the api key and secret were valid check the configuration in your portal, it is possibilty these were IP restricted or are disabled. |
Please also see common HTTP status codes.
Sample response body
{
"scheduledTaskQueueGuid": "c45caa30-a836-4d5d-84a7-fa32638a9ea0",
"automationTaskGuid": "7f250b8d-537a-4e76-b803-43f63c83ee47",
"state": 0,
"addedDate": "2018-02-07T10:34:54.648",
"startDate": "2018-02-09T08:32:14.657",
"endDate": "2018-02-10T12:14:24.12",
"resultCode": 1,
"resultText": "Task has been started",
"options": 0
}
Example request with cURL
Replace placeholder values surrounded by { } with the actual values.
curl -u {api-key}:{api-secret} -X GET https://{company-name}.helloid.com/api/v1/automation/tasks/{taskGuid}/start