The Get Global Automation Variables operation will return a list of the global variables.
Request
Request URI
| Method | Request URI |
|---|---|
| GET | https://{company-name}.helloid.com/api/v1/automation/variables |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
Request headers
None.
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful and the resource is created. |
| 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. |
| 409(CONFLICT) | Indicates that the operation was not successful. If there were validation errors, the response will include an error result. |
Please also see error result.
Please also see common HTTP status codes.
Response parameters
The response contains a list of variable objects.
Variable object
| Parameter | Description |
|---|---|
| automationVariableGuid | The GUID of the variable. |
| name | The name of the variable. |
| value | The value of the variable. |
| secret | A boolean value indicating if the value of the variable is encrypted. |
Sample response body
[
{
"automationVariableGuid": "3df6c5d8-aec6-408a-8e24-11c3ea708f8c",
"name": "var1",
"value": "val1",
"secret": false
},
{
"automationVariableGuid": "d89be614-317a-4dc4-a05e-14d66101596c",
"name": "var2",
"value": "CJAGZWwSf4pSpsQW+3SJ+f4ki/DtNqPaa2OZhUvy4KnQRs8ibo4iEyjxtrDx4PHndfF7P/0c/oRNkdrRbvCgtp2DfJ8tsbpC87Zok8bDIvmYywCcXfJimeP/iVnP98RIkXOIspnmy24/WTzTx6rMsKyEmlxAOeE8C5LSQvCsTTU=",
"secret": true
}
]<
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/variables