The Get Actions operation will return a list of Self Service actions.
Request
Request URI
| Method | Request URI |
|---|---|
| GET | https://{company-name}.helloid.com/api/v1/selfservice/actions/{?skip={skip}}/{?take={take}} |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {?skip} | Optional. The amount of actions to skip, ordered by ActionGUID. If the {skip} parameter is not supplied, no actions will be skipped. |
| {?take} | Optional. The amount of actions to request, ordered by ActionGUID. If not supplied, a maximum of 50 actions will be returned. |
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. |
| 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 actions. Depending on the executionType and executionEntry, the object has different variables.
Product object
| Parameter | Description |
|---|---|
| actionGUID | The GUID of the action |
| name | The name of the action |
| options | |
| objectGUID | The GUID of the product for which the action will execute |
| executeOnState | Action will be executed on this state. The states can be: 1-Requested, 3-Approved, 5-Denied, 7-Deleted, 9-Revoked/Withdrawn, 11-Returned |
| automationStoreTaskId | The GUID of the task in the HelloID Automation Store |
| automationStoreTaskVersion | The version of the task in the HelloID Automation Store. Can be specific or semantic, e.g. 1.0.0 or 1.0.* |
| executionType | The type of execution, e.g. native or powershell |
| executionEntry | The execution entry, e.g. send-email or main.ps1 |
| executionEnvironment | The execution environment, e.g. helloid-agent or helloid |
| executionMinimumVersion | The minimum version of the HelloID agent for executing this action |
| variables | A list of available action variables which are set specific for the current action. |
Sample response body
{
"totalRowCount": 150,
"pageData": [
{
"actionGUID": "b76ac6ce-8f38-49df-aca1-3336d1f5455b",
"name": "Send email action",
"options": 0,
"objectGUID": "b05596a8-eb96-4284-8c44-c0726b79e1ec",
"executeOnState": 5,
"automationStoreTaskId": "4768fd73-622c-4cc6-bece-5ccba5bac8c2",
"automationStoreTaskVersion": "1.0.*",
"executionType": "native",
"executionEntry": "send-email",
"executionEnvironment": "helloid",
"executionMinimumVersion": "1.1.0",
"variables": [
{
"id": "218ac878-a699-4212-bbf5-03d8a0d8f238",
"name": "useTemplate",
"value": "true",
"typeConstraint": "boolean",
"secure": false,
"isScriptVariable": false
},
{
"id": "ed64b638-4de8-4bc4-adb0-261c1b92824c",
"name": "to",
"value": "{{requester.ContactEmail}}",
"typeConstraint": "string",
"secure": false,
"isScriptVariable": false
},
{
"id": "6495d842-9f31-4adb-87d6-2c448d8fde5c",
"name": "content",
"value": null,
"typeConstraint": "string",
"secure": false,
"isScriptVariable": false
},
{
"id": "30a66ede-ff80-43ab-bc15-65fc5d37bb53",
"name": "template",
"value": "senddeniedemail",
"typeConstraint": "string",
"secure": false,
"isScriptVariable": false
},
{
"id": "edc0b3da-efbc-4476-b890-6ac47c7f1053",
"name": "subject",
"value": "Request Denied",
"typeConstraint": "string",
"secure": false,
"isScriptVariable": false
},
{
"id": "85b559d9-e225-41c0-aef1-9381cf923d5b",
"name": "isHtmlContent",
"value": "true",
"typeConstraint": "boolean",
"secure": false,
"isScriptVariable": false
},
{
"id": "137baa68-43f7-4b27-bd17-a096ee6b13f7",
"name": "from",
"value": "{{handler.ContactEmail}}",
"typeConstraint": "string",
"secure": false,
"isScriptVariable": false
}
]
},
{
...
}
]
}
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/selfservice/actions