| The capabilities described on this page are included in Appian's standard capability tier. Usage limits may apply. |
Tip: Remember to include the appropriate authentication headers in your HTTP request message when using this method.
POST: /robot/list
This method returns the list of all robotic tasks that the user is allowed to view.
This endpoint accepts no request parameters. You may have to add an empty JSON ({}) to the raw request to receive a response.
The call is successful if "invocationResult" = "OK".
The following elements are provided in the result.robots key.
| Element | Example | Data type | Description |
|---|---|---|---|
name |
"5da9aafe4cea9d1772d9031b" | String | Robotic task name, immutable since creation |
id |
"5da9aafe4cea9d1772d9031c" | String | Robotic task ID |
customName |
"Example task" | String | Robotic task human-readable name |
spokenName |
"Example task" | String | Robotic task spoken name |
expressions |
"delta": ["four"] | Map | Map of expressions |
environment |
"a": "alfa", "b": "beta", "z": "3" | Array | List of environmental values |
itemsName |
"bits" | String | Items friendly name |
description |
- | String | Robotic task description |
involvedSystems |
- | - | - |
inputExpected |
- | - | Input expected by the robotic task |
outputExpected |
- | - | Output expected from the robotic task |
disabled |
false | Boolean | Indicates if executions are disabled |
testing |
false | Boolean | Indicates if testing mode is active |
minimumLogLevel |
"TRACE" | String | Default log level, possible values are: TRACE, DEBUG, INFO, WARN, ERROR, FATAL |
priority |
"HIGH" | String | The execution's priority level, relative to other executions |
simultaneousRunning |
3 | Integer | Maximum simultaneous executions for the robotic task (0 means no limit) |
restrictHours |
false | Boolean | Indicates if executions are restricted to specified hours |
restrictHoursSchedule |
- | Array | Array of schedule data if previous field is set to true |
restrictHoursSchedule.id |
5da9aafe4cea9d1772d9031c | String | Robotic task ID |
restrictHoursSchedule.robotName |
null | String | - |
restrictHoursSchedule.description |
- | String | Robotic task description |
restrictHoursSchedule.active |
false | Boolean | - |
restrictHoursSchedule.color |
"#000000" | String | Hexidecimal code for the color this robotic task uses in graphics |
restrictHoursSchedule.minutes |
"type": "WHEN", "every": 0, "when": [] | Array | - |
restrictHoursSchedule.hours |
"type": "WHEN", "every": 0, "when": [11, 12, 17, 18] | Array | - |
restrictHoursSchedule.days |
"type": "WHEN", "every": 0, "when": [] | Array | - |
restrictHoursSchedule.daysOfWeek |
"type": "WHEN", "every": 0, "when": [6, 0] | Array | Days of the week in Java calendar format |
restrictHoursSchedule.instructions |
- | - | Not used |
restrictHoursSchedule.executionsToLaunch |
- | - | Not used |
removeOldArtifacts |
0 | Integer | Days to removed artifacts (0 means never) |
subResultTexts |
"RED": "red", "CORAL": "australia", "LIGHT_GRAY": "discrete", "LIME": "fresh", "CHOCOLATE": "sweet", "OLIVE": "", "MAGENTA": "highlight", "CYAN": "sky", "DARK_GRAY": "shadow", "INDIGO": "deep" | Array | Descriptions of colors to categorize items results in the robotic task |
lastExecution |
1569245555136 | String | Date and time of the robotic task's last execution, expressed in UNIX epoch time Units: milliseconds |
color |
"#9fe1e7" | String | Hexidecimal code for the color this robotic task uses in graphics |
labels |
"dev", "developer", "internet-explorer", "remote", "windows!", "chrome-75" | Array | Array to data regarding robotic task permissions |
instructions |
"name": "fail", "description": "fail", "type": "BOOLEAN", "defaultValue": "false", "required": false | Array | Array of data regarding robotic task parameters |
Example response body:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
{
"invocationResult": "OK",
"result": {
"lastUpdated": 1627659438694,
"errorMessage": null,
"robots": [
{
"name": "60b7dd32e4b0ca0d6e6341a8",
"id": "5efb185af9e21a2764d22393",
"customName": "Documentation",
"spokenName": null,
"expressions": {},
"environment": {},
"itemsName": "items",
"description": null,
"involvedSystems": null,
"inputExpected": null,
"outputExpected": null,
"disabled": false,
"testing": false,
"minimumLogLevel": "TRACE",
"priority": "NORMAL",
"simultaneousRunning": 0,
"restrictHours": false,
"restrictHoursSchedule": null,
"removeOldArtifacts": 0,
"subResultTexts": {},
"lastExecution": 0,
"color": "#000000",
"labels": [
"roleoperation"
],
"instructions": [],
"technology": "JAVA"
},
{
"name": "60ccc933e4b0ca0d6e6341ae",
"id": "5efb1872f9e21a2764d22396",
"customName": "Browser",
"spokenName": null,
"expressions": {},
"environment": {},
"itemsName": "items",
"description": null,
"involvedSystems": null,
"inputExpected": null,
"outputExpected": null,
"disabled": false,
"testing": false,
"minimumLogLevel": "TRACE",
"priority": "NORMAL",
"simultaneousRunning": 0,
"restrictHours": false,
"restrictHoursSchedule": null,
"removeOldArtifacts": 0,
"subResultTexts": {},
"lastExecution": 0,
"color": "#000000",
"labels": [
"roleoperation"
],
"instructions": [],
"technology": "JAVA"
},
{
"name": "61040365e4b0c8349a1c3366",
"id": "5efb1872f9e21a2764d22396",
"customName": "APPN-Stock-Price",
"spokenName": "",
"expressions": {},
"environment": {},
"itemsName": "items",
"description": "",
"involvedSystems": "",
"inputExpected": "",
"outputExpected": "",
"disabled": false,
"testing": false,
"minimumLogLevel": "TRACE",
"priority": "NORMAL",
"simultaneousRunning": 0,
"restrictHours": false,
"restrictHoursSchedule": null,
"removeOldArtifacts": 0,
"subResultTexts": {
"RED": "",
"CORAL": "",
"LIGHT_GRAY": "",
"LIME": "",
"CHOCOLATE": "",
"OLIVE": "",
"MAGENTA": "",
"CYAN": "",
"DARK_GRAY": "",
"INDIGO": ""
},
"lastExecution": 1627654956579,
"color": "#000000",
"labels": [
"roleoperation"
],
"instructions": [],
"technology": "JAVA"
}
]
},
"exceptionThrownText": null
}
Possible reasons calls may be unsuccessful ("invocationResult" = "KO"):
Get Robotic Task List
