-
Notifications
You must be signed in to change notification settings - Fork 0
/
RequestsDictionary.json
294 lines (255 loc) · 9.47 KB
/
RequestsDictionary.json
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
{
"get_service_list" :
{
"url" : "/",
"method" : "GET",
"expected_url_complement" : {},
"expected_url_params" : {},
"expected_data_params" : {},
"default_params" : {},
"success_response" : 200,
"error_response" : [400, 404],
"description" : "Returns the services list"
},
"logout" :
{
"url" : "/logout",
"method" : "GET",
"expected_url_complement" : {},
"expected_url_params" : {},
"expected_data_params" : {},
"default_params" : {},
"success_response" : 204,
"error_response" : [400],
"description" : "Performs logging out"
},
"get_rapid_variable_data" :
{
"url" : "/rw/rapid/symbol/data/RAPID",
"method" : "GET",
"expected_url_complement" :
{
"task": {"required" : 1, "default_value" : {}, "possible_values" : [], "description" : "RAPID task wherin the variable is defined"},
"module" : {"required" : 1, "default_value" : {}, "possible_values" : [], "description" : "RAPID module wherin the variable is defined"},
"variable" : {"required" : 1, "default_value" : {}, "possible_values" : [], "description" : "Name of the RAPID variable"}
},
"expected_url_params" : {},
"expected_data_params" : {},
"default_params" : {},
"success_response" : 200,
"error_response" : [400],
"description" : "Returns RAPID variable state"
},
"update_rapid_variable_current_value" :
{
"url" : "/rw/rapid/symbol/data/RAPID",
"method" : "POST",
"expected_url_complement" :
{
"task": {"required" : 1, "default_value" : {}, "possible_values" : [], "description" : "RAPID task wherin the variable is defined"},
"module" : {"required" : 1, "default_value" : {}, "possible_values" : [], "description" : "RAPID module wherin the variable is defined"},
"variable" : {"required" : 1, "default_value" : {}, "possible_values" : [], "description" : "Name of the RAPID variable"}
},
"expected_url_params" : {},
"expected_data_params" :
{
"value" : {"required" : 1, "default_value" : "true", "possible_values" : ["boolean", "num", "string"], "description" : "Value to be written"}
},
"default_params" : {"action" : "set"},
"success_response" : 204,
"error_response" : [400, 403],
"description" : "Update the current value of a RAPID variable"
},
"subscribe_on_resources" :
{
"url" : "/subscription",
"method" : "POST",
"expected_url_complement" : {},
"expected_url_params" : {},
"expected_data_params" : {},
"default_params" : {},
"success_response" : 201,
"error_response" : [400, 415],
"description" : "Subscribe on resources"
},
"get_subscription_actions" :
{
"url" : "/subscription",
"method" : "GET",
"expected_url_complement" : {},
"expected_url_params" : {},
"expected_data_params" : {},
"default_params" : {"action" : "show"},
"success_response" : 200,
"error_response" : [400],
"description" : "Returns possible actions with the subscription service"
},
"get_user_resources" :
{
"url" : "/users",
"method" : "GET",
"expected_url_complement" : {},
"expected_url_params" : {"user-type" : {"required" : 0, "default_value" : "None", "possible_values" : ["self", "None"], "description" : "Type of user"}},
"expected_data_params" : {},
"default_params" : {},
"success_response" : 200,
"error_response" : [400],
"description" : "Returns user ressources"
},
"get_user_actions" :
{
"url" : "/users",
"method" : "GET",
"expected_url_complement" : {},
"expected_url_params" : {},
"expected_data_params" : {},
"default_params" : {"action" : "show"},
"success_response" : 200,
"error_response" : [400],
"description" : "user actions"
},
"get_controller_resources" :
{
"url" : "/ctrl",
"method" : "GET",
"expected_url_complement" : {},
"expected_url_params" : {},
"expected_data_params" : {},
"default_params" : {},
"success_response" : 200,
"error_response" : [404],
"description" : "Returns controller resources"
},
"get_controller_actions" :
{
"url" : "/ctrl",
"method" : "GET",
"expected_url_complement" : {},
"expected_url_params" : {},
"expected_data_params" : {},
"default_params" : {"action" : "show"},
"success_response" : 200,
"error_response" : [404],
"description" : "Returns actions available on controller resources"
},
"get_file_service_resources" :
{
"url" : "/fileservice",
"method" : "GET",
"expected_url_complement" : {},
"expected_url_params" : {},
"expected_data_params" : {},
"default_params" : {},
"success_response" : 200,
"error_response" : [401, 404],
"description" : "Returns file service resources"
},
"get_robotware_services" :
{
"url" : "/rw",
"method" : "GET",
"expected_url_complement" : {},
"expected_url_params" : {},
"expected_data_params" : {},
"default_params" : {},
"success_response" : 200,
"error_response" : [401, 404],
"description" : "Returns robotware services"
},
"get_rapid_system_resources" :
{
"url" : "/rw/rapid",
"method" : "GET",
"expected_url_complement" : {},
"expected_url_params" : {},
"expected_data_params" : {},
"default_params" : {},
"success_response" : 200,
"error_response" : [401, 404],
"description" : "Returns RAPID resources"
},
"get_rapid_execution_state" :
{
"url" : "/rw/rapid/execution",
"method" : "GET",
"expected_url_complement" : {},
"expected_url_params" : {"continue-on-err" : {"required" : 0, "default_value" : "None", "possible_values" : ["1", "0", "None"], "description" : "Continue on error"}},
"expected_data_params" : {},
"default_params" : {},
"success_response" : 200,
"error_response" : [400],
"description" : "Returns RAPID execution state"
},
"get_rapid_execution_actions" :
{
"url" : "/rw/rapid/execution",
"method" : "GET",
"expected_url_complement" : {},
"expected_url_params" : {},
"expected_data_params" : {},
"default_params" : {"action" : "show"},
"success_response" : 200,
"error_response" : [400],
"description" : "Returns available actions on RAPID execution"
},
"start_rapid_execution" :
{
"url" : "/rw/rapid/execution",
"method" : "POST",
"expected_url_complement" : {},
"expected_url_params" : {},
"expected_data_params" :
{
"regain" : {"required" : 1, "default_value" : "continue", "possible_values" : ["continue", "regain", "clear"], "description" : "Regain"},
"execmode" : {"required" : 1, "default_value" : "continue", "possible_values" : ["continue", "stepin", "stepover", "stepout", "stepback", "steplast", "stepmotion"], "description" : "Execution mode"},
"cycle" : {"required" : 1, "default_value" : "once", "possible_values" : ["forever", "asis", "once"], "description" : "Cycle"},
"condition" : {"required" : 1, "default_value" : "none", "possible_values" : ["none", "callchain"], "description" : "Condition"},
"stopatbp" : {"required" : 1, "default_value" : "disabled", "possible_values" : ["disabled", "enabled"], "description" : "Stop execution at breakpoint"},
"alltaskbytsp" : {"required" : 1, "default_value" : "false", "possible_values" : ["true", "false"], "description" : "alltaskbytsp"}
},
"default_params" : {"action" : "start"},
"success_response" : 204,
"error_response" : [400],
"description" : "Starts a RAPID execution. The robot has to be in 'Auto' mode."
},
"stop_rapid_execution" :
{
"url" : "/rw/rapid/execution",
"method" : "POST",
"expected_url_complement" : {},
"expected_url_params" : {},
"expected_data_params" :
{
"stopmode" : {"required" : 1, "default_value" : "stop", "possible_values" : ["cycle", "instr", "stop", "qstop"], "description" : "Stop mode"},
"usetsp" : {"required" : 1, "default_value" : "normal", "possible_values" : ["normal", "alltsk"], "description" : "Use tsp"}
},
"default_params" : {"action" : "stop"},
"success_response" : 204,
"error_response" : [400],
"description" : "Stops a RAPID execution. The robot has to be in 'Auto' mode."
},
"start_rapid_execution_from_prod_entry" :
{
"url" : "/rw/rapid/execution",
"method" : "POST",
"expected_url_complement" : {},
"expected_url_params" : {},
"expected_data_params" : {},
"default_params" : {"action" : "startprodentry"},
"success_response" : 204,
"error_response" : [400],
"description" : "Starts a RAPID execution from a production entry"
},
"reset_rapid_program_pointer_to_main" :
{
"url" : "/rw/rapid/execution",
"method" : "POST",
"expected_url_complement" : {},
"expected_url_params" : {},
"expected_data_params" : {},
"default_params" : {"action" : "resetpp"},
"success_response" : 204,
"error_response" : [400],
"description" : "Resets the program pointer (RAPID) to main procedure (PROC main). The robot has to be in 'Auto' mode."
}
}