The Get Automation Task operation will return the automation task with the given GUID.
Request
Request URI
| Method | Request URI |
|---|---|
| GET | https://{company-name}.helloid.com/api/v1/automationtasks/{automationTaskGuid} |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {automationTaskGuid} | The identifier of the task to GET |
Request headers
None.
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful. |
| 400(BAD REQUEST) | Indicates that the operation was not successful. The content type was incorrect 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 error result.
Please also see common HTTP status codes.
Response parameters
The response contains an automation task object.
Automation task object
| Parameter | Description |
|---|---|
| automationTaskGuid | The GUID of the automation task |
| name | The name of the automation task |
| id | Identifier of the task from the task store |
| type | Native or PowerShell |
| version | Version of the task from the task store |
| objectGuid | The object to which this task belongs. For example Product or Delegated Form |
| agentPoolGUID | Optional agent pool guid |
| metaData | In the case of a selfservice product, on which state the task will be executed |
| variables | List of variables belonging to this task. Note that a PowerShell script is stored internally as a variable |
| contexts | Selfservice or Automation |
| automationContainer | PowerShell = 1, SelfService = 2, Events = 4, DelegatedForms = 8 |
| executionType | Metadata about the task from the taskstore |
| executionEntry | Metadata about the task from the taskstore |
| executionEnvironment | Metadata about the task from the taskstore |
| executionMinimumVersion | Metadata about the task from the taskstore |
| editor | Metadata about the task from the taskstore |
| isNew | false |
| isEnabled | Is the task enabled |
| isTemporary | false |
Sample response body
{
"automationTaskGuid": "d95d574f-781a-4548-a70a-9a1a2d235ac0",
"id": "f722b69a-f2f3-42c8-89df-f094a2e22d47",
"name": "Automation Task to run powershell",
"type": "powershell",
"version": "1.0.*",
"isValid": false,
"executionType": "powershell",
"executionEntry": "main.ps1",
"executionEnvironment": "helloid-agent",
"executionMinimumVersion": "4.1.0",
"editor": "default",
"objectGuid": "00000000-0000-0000-0000-000000000000",
"agentPoolGUID": "adb27224-431d-4140-b5ae-cd78ac6eae3a",
"metaData": null,
"variables": [],
"contexts": [
"automation"
],
"isNew": false,
"isEnabled": true,
"isTemporary": false,
"automationContainer": 1
}<
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/automationtasks/{automationTaskGuid}