The Get search tasks by name in context & category operation will return a list of tasks that match the provided name, category and given context. The taskname parameter can be left empty to get a complete list of all available tasks within the provided context and category.
Request
Request URI
| Method | Request URI |
|---|---|
| GET | https://{company-name}.helloid.com/api/v1/automationstore/tasks/context/{context}/category/{category}/{taskName} |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {context} | The context the task must be in. Example: "selfservice" |
| {category} | The category the task must be in. |
| {taskname} | The task's name (optional) |
Request headers
| Header | Description |
|---|---|
| Content-Type | Required. Must be set to application/json. |
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 |
|---|---|
| id | The GUID of the task. |
| name | The name of the task. |
| displayName | The name of the task (same as name). |
| description | The task's description |
| author | The author that created the task |
| icon | A UTF-8 encoded string of the icon's bytes |
| lastModifiedOn | The date the task was last modified |
| latestVersionMajor | The current major version number (1.0.3) |
| latestVersionMinor | The current minor version number (1.0.3) |
| latestVersionPatch | The current patch version number (1.0.3) |
| isEnabled | Whether the task is currently enabled |
| contexts | The a list of contexts the tasks is available in |
| categories | The list of categories the task is placed in |
Sample response body
[
{
"id": "3df6c5d8-aec6-408a-8e24-11c3ea708f8c",
"name": "TaskName",
"displayName": "TaskName",
"description": "Task description",
"author": "Tools4ever",
"icon": "utf-8 encoded byte array",
"lastModifiedOn": "2018-02-07T10:34:54.648",
"latestVersionMajor": 1,
"latestVersionMinor": 0,
"latestVersionPatch": 3,
"isEnabled": true,
"contexts": [
"selfservice"
],
"categories": [
"development"
]
}
]
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/automationstore/tasks/context/{context}/category/{category}/{search}