@wandelbots/nova-api 25.5.0-dev.11 → 25.5.0-dev.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/v2/api.d.ts +242 -502
- package/v2/api.js +235 -242
- package/v2/api.js.map +1 -1
- package/v2/api.ts +332 -592
package/v2/api.d.ts
CHANGED
|
@@ -235,118 +235,6 @@ export interface App {
|
|
|
235
235
|
*/
|
|
236
236
|
'health_path'?: string;
|
|
237
237
|
}
|
|
238
|
-
/**
|
|
239
|
-
*
|
|
240
|
-
* @export
|
|
241
|
-
* @interface ArrayInput
|
|
242
|
-
*/
|
|
243
|
-
export interface ArrayInput {
|
|
244
|
-
/**
|
|
245
|
-
*
|
|
246
|
-
* @type {Array<ArrayInputArrayInner>}
|
|
247
|
-
* @memberof ArrayInput
|
|
248
|
-
*/
|
|
249
|
-
'array': Array<ArrayInputArrayInner>;
|
|
250
|
-
}
|
|
251
|
-
/**
|
|
252
|
-
*
|
|
253
|
-
* @export
|
|
254
|
-
* @interface ArrayInputArrayInner
|
|
255
|
-
*/
|
|
256
|
-
export interface ArrayInputArrayInner {
|
|
257
|
-
/**
|
|
258
|
-
*
|
|
259
|
-
* @type {Array<any>}
|
|
260
|
-
* @memberof ArrayInputArrayInner
|
|
261
|
-
*/
|
|
262
|
-
'pose': Array<any>;
|
|
263
|
-
/**
|
|
264
|
-
*
|
|
265
|
-
* @type {Array<any>}
|
|
266
|
-
* @memberof ArrayInputArrayInner
|
|
267
|
-
*/
|
|
268
|
-
'position': Array<any>;
|
|
269
|
-
/**
|
|
270
|
-
*
|
|
271
|
-
* @type {Array<any>}
|
|
272
|
-
* @memberof ArrayInputArrayInner
|
|
273
|
-
*/
|
|
274
|
-
'orientation': Array<any>;
|
|
275
|
-
/**
|
|
276
|
-
*
|
|
277
|
-
* @type {string}
|
|
278
|
-
* @memberof ArrayInputArrayInner
|
|
279
|
-
*/
|
|
280
|
-
'image': string;
|
|
281
|
-
/**
|
|
282
|
-
*
|
|
283
|
-
* @type {string}
|
|
284
|
-
* @memberof ArrayInputArrayInner
|
|
285
|
-
*/
|
|
286
|
-
'pointcloud': string;
|
|
287
|
-
/**
|
|
288
|
-
*
|
|
289
|
-
* @type {Array<ArrayInputArrayInner>}
|
|
290
|
-
* @memberof ArrayInputArrayInner
|
|
291
|
-
*/
|
|
292
|
-
'array': Array<ArrayInputArrayInner>;
|
|
293
|
-
}
|
|
294
|
-
/**
|
|
295
|
-
*
|
|
296
|
-
* @export
|
|
297
|
-
* @interface ArrayOutput
|
|
298
|
-
*/
|
|
299
|
-
export interface ArrayOutput {
|
|
300
|
-
/**
|
|
301
|
-
*
|
|
302
|
-
* @type {Array<ArrayOutputArrayInner>}
|
|
303
|
-
* @memberof ArrayOutput
|
|
304
|
-
*/
|
|
305
|
-
'array': Array<ArrayOutputArrayInner>;
|
|
306
|
-
}
|
|
307
|
-
/**
|
|
308
|
-
*
|
|
309
|
-
* @export
|
|
310
|
-
* @interface ArrayOutputArrayInner
|
|
311
|
-
*/
|
|
312
|
-
export interface ArrayOutputArrayInner {
|
|
313
|
-
/**
|
|
314
|
-
*
|
|
315
|
-
* @type {Array<any>}
|
|
316
|
-
* @memberof ArrayOutputArrayInner
|
|
317
|
-
*/
|
|
318
|
-
'pose': Array<any>;
|
|
319
|
-
/**
|
|
320
|
-
*
|
|
321
|
-
* @type {Array<any>}
|
|
322
|
-
* @memberof ArrayOutputArrayInner
|
|
323
|
-
*/
|
|
324
|
-
'position': Array<any>;
|
|
325
|
-
/**
|
|
326
|
-
*
|
|
327
|
-
* @type {Array<any>}
|
|
328
|
-
* @memberof ArrayOutputArrayInner
|
|
329
|
-
*/
|
|
330
|
-
'orientation': Array<any>;
|
|
331
|
-
/**
|
|
332
|
-
*
|
|
333
|
-
* @type {string}
|
|
334
|
-
* @memberof ArrayOutputArrayInner
|
|
335
|
-
*/
|
|
336
|
-
'image': string;
|
|
337
|
-
/**
|
|
338
|
-
*
|
|
339
|
-
* @type {string}
|
|
340
|
-
* @memberof ArrayOutputArrayInner
|
|
341
|
-
*/
|
|
342
|
-
'pointcloud': string;
|
|
343
|
-
/**
|
|
344
|
-
*
|
|
345
|
-
* @type {Array<ArrayOutputArrayInner>}
|
|
346
|
-
* @memberof ArrayOutputArrayInner
|
|
347
|
-
*/
|
|
348
|
-
'array': Array<ArrayOutputArrayInner>;
|
|
349
|
-
}
|
|
350
238
|
/**
|
|
351
239
|
* ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion group instantly takes any commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g. with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](externalJointsStream).
|
|
352
240
|
* @export
|
|
@@ -557,19 +445,6 @@ export declare const Capsule2ShapeTypeEnum: {
|
|
|
557
445
|
readonly Capsule: "capsule";
|
|
558
446
|
};
|
|
559
447
|
export type Capsule2ShapeTypeEnum = typeof Capsule2ShapeTypeEnum[keyof typeof Capsule2ShapeTypeEnum];
|
|
560
|
-
/**
|
|
561
|
-
*
|
|
562
|
-
* @export
|
|
563
|
-
* @interface Capture
|
|
564
|
-
*/
|
|
565
|
-
export interface Capture {
|
|
566
|
-
/**
|
|
567
|
-
*
|
|
568
|
-
* @type {string}
|
|
569
|
-
* @memberof Capture
|
|
570
|
-
*/
|
|
571
|
-
'image': string;
|
|
572
|
-
}
|
|
573
448
|
/**
|
|
574
449
|
* To create a robot cell, only a valid name is required. Once created, a robot cell provides access to the Wandelbots NOVA foundation services. The configuration can be customized, e.g. robot controllers, also within apps.
|
|
575
450
|
* @export
|
|
@@ -601,27 +476,6 @@ export interface Cell {
|
|
|
601
476
|
*/
|
|
602
477
|
'apps'?: Array<App>;
|
|
603
478
|
}
|
|
604
|
-
/**
|
|
605
|
-
*
|
|
606
|
-
* @export
|
|
607
|
-
* @interface CodeWithArguments
|
|
608
|
-
*/
|
|
609
|
-
export interface CodeWithArguments {
|
|
610
|
-
/**
|
|
611
|
-
* Wandelscript code string which describes a Wandelscript Program as content/json.
|
|
612
|
-
* @type {string}
|
|
613
|
-
* @memberof CodeWithArguments
|
|
614
|
-
*/
|
|
615
|
-
'code': string;
|
|
616
|
-
/**
|
|
617
|
-
*
|
|
618
|
-
* @type {{ [key: string]: ArrayInputArrayInner; }}
|
|
619
|
-
* @memberof CodeWithArguments
|
|
620
|
-
*/
|
|
621
|
-
'initial_state'?: {
|
|
622
|
-
[key: string]: ArrayInputArrayInner;
|
|
623
|
-
} | null;
|
|
624
|
-
}
|
|
625
479
|
/**
|
|
626
480
|
* Defines a collider with a single shape. A collider is an object that is used for collision detection. It defines the `shape` that is attached with the offset of `pose` to a reference frame. Use colliders to: - Define the shape of a workpiece. The reference frame is the scene origin. - Define the shape of a link in a motion group. The reference frame is the link coordinate system. - Define the shape of a tool. The reference frame is the flange coordinate system.
|
|
627
481
|
* @export
|
|
@@ -1175,26 +1029,26 @@ export interface CoordinateSystems {
|
|
|
1175
1029
|
/**
|
|
1176
1030
|
*
|
|
1177
1031
|
* @export
|
|
1178
|
-
* @interface
|
|
1032
|
+
* @interface CreateProgramOperatorRun200Response
|
|
1179
1033
|
*/
|
|
1180
|
-
export interface
|
|
1034
|
+
export interface CreateProgramOperatorRun200Response {
|
|
1181
1035
|
/**
|
|
1182
1036
|
* The identifier of the program run for further inspection of the running program.
|
|
1183
1037
|
* @type {string}
|
|
1184
|
-
* @memberof
|
|
1038
|
+
* @memberof CreateProgramOperatorRun200Response
|
|
1185
1039
|
*/
|
|
1186
1040
|
'id'?: string;
|
|
1187
1041
|
}
|
|
1188
1042
|
/**
|
|
1189
1043
|
*
|
|
1190
1044
|
* @export
|
|
1191
|
-
* @interface
|
|
1045
|
+
* @interface CreateProgramOperatorRunRequest
|
|
1192
1046
|
*/
|
|
1193
|
-
export interface
|
|
1047
|
+
export interface CreateProgramOperatorRunRequest {
|
|
1194
1048
|
/**
|
|
1195
1049
|
* The identifier of the program stored in the program library.
|
|
1196
1050
|
* @type {string}
|
|
1197
|
-
* @memberof
|
|
1051
|
+
* @memberof CreateProgramOperatorRunRequest
|
|
1198
1052
|
*/
|
|
1199
1053
|
'program_id': string;
|
|
1200
1054
|
}
|
|
@@ -1407,31 +1261,6 @@ export type ExecuteTrajectoryRequest = InitializeMovementRequest | PauseMovement
|
|
|
1407
1261
|
* @export
|
|
1408
1262
|
*/
|
|
1409
1263
|
export type ExecuteTrajectoryResponse = InitializeMovementResponse | Movement | MovementError | PauseMovementResponse | PlaybackSpeedResponse | Standstill;
|
|
1410
|
-
/**
|
|
1411
|
-
* The ExecutionResult object contains the execution results of a robot. Arguments: motion_group_id: The unique identifier of the motion group motion_duration: The total execution duration of the motion group paths: The paths of the motion group as list of Path objects
|
|
1412
|
-
* @export
|
|
1413
|
-
* @interface ExecutionResult
|
|
1414
|
-
*/
|
|
1415
|
-
export interface ExecutionResult {
|
|
1416
|
-
/**
|
|
1417
|
-
*
|
|
1418
|
-
* @type {string}
|
|
1419
|
-
* @memberof ExecutionResult
|
|
1420
|
-
*/
|
|
1421
|
-
'motion_group_id': string;
|
|
1422
|
-
/**
|
|
1423
|
-
*
|
|
1424
|
-
* @type {number}
|
|
1425
|
-
* @memberof ExecutionResult
|
|
1426
|
-
*/
|
|
1427
|
-
'motion_duration': number;
|
|
1428
|
-
/**
|
|
1429
|
-
*
|
|
1430
|
-
* @type {Array<Path>}
|
|
1431
|
-
* @memberof ExecutionResult
|
|
1432
|
-
*/
|
|
1433
|
-
'paths': Array<Path>;
|
|
1434
|
-
}
|
|
1435
1264
|
/**
|
|
1436
1265
|
* A datapoint inside external joint stream.
|
|
1437
1266
|
* @export
|
|
@@ -1758,13 +1587,13 @@ export interface Geometry {
|
|
|
1758
1587
|
/**
|
|
1759
1588
|
*
|
|
1760
1589
|
* @export
|
|
1761
|
-
* @interface
|
|
1590
|
+
* @interface GetAllProgramOperatorRuns200Response
|
|
1762
1591
|
*/
|
|
1763
|
-
export interface
|
|
1592
|
+
export interface GetAllProgramOperatorRuns200Response {
|
|
1764
1593
|
/**
|
|
1765
1594
|
*
|
|
1766
1595
|
* @type {Array<ProgramRunObject>}
|
|
1767
|
-
* @memberof
|
|
1596
|
+
* @memberof GetAllProgramOperatorRuns200Response
|
|
1768
1597
|
*/
|
|
1769
1598
|
'program_runs'?: Array<ProgramRunObject>;
|
|
1770
1599
|
}
|
|
@@ -3854,19 +3683,6 @@ export declare const OrientationType: {
|
|
|
3854
3683
|
readonly EulerAnglesExtrinsicZxy: "EULER_ANGLES_EXTRINSIC_ZXY";
|
|
3855
3684
|
};
|
|
3856
3685
|
export type OrientationType = typeof OrientationType[keyof typeof OrientationType];
|
|
3857
|
-
/**
|
|
3858
|
-
*
|
|
3859
|
-
* @export
|
|
3860
|
-
* @interface Path
|
|
3861
|
-
*/
|
|
3862
|
-
export interface Path {
|
|
3863
|
-
/**
|
|
3864
|
-
*
|
|
3865
|
-
* @type {Array<RobotState>}
|
|
3866
|
-
* @memberof Path
|
|
3867
|
-
*/
|
|
3868
|
-
'poses'?: Array<RobotState>;
|
|
3869
|
-
}
|
|
3870
3686
|
/**
|
|
3871
3687
|
* A cartesian point-to-point is representing a joint point-to-point motion from start point to the indicated target pose. The target pose is a joint point-to-point given in cartesian space. The target joint configuration will be calculated to be in the same kinematic configuration as the start point is. If that is not possible, planning will fail.
|
|
3872
3688
|
* @export
|
|
@@ -4363,19 +4179,6 @@ export interface PlaybackSpeedResponsePlaybackSpeedResponse {
|
|
|
4363
4179
|
*/
|
|
4364
4180
|
'requested_value': number;
|
|
4365
4181
|
}
|
|
4366
|
-
/**
|
|
4367
|
-
*
|
|
4368
|
-
* @export
|
|
4369
|
-
* @interface PointCloud
|
|
4370
|
-
*/
|
|
4371
|
-
export interface PointCloud {
|
|
4372
|
-
/**
|
|
4373
|
-
*
|
|
4374
|
-
* @type {string}
|
|
4375
|
-
* @memberof PointCloud
|
|
4376
|
-
*/
|
|
4377
|
-
'pointcloud': string;
|
|
4378
|
-
}
|
|
4379
4182
|
/**
|
|
4380
4183
|
* Defines a pose in 3D space. A pose is a combination of a position and an orientation. The position is applied before the orientation.
|
|
4381
4184
|
* @export
|
|
@@ -4423,17 +4226,50 @@ export interface PoseInCoordinateSystem {
|
|
|
4423
4226
|
/**
|
|
4424
4227
|
*
|
|
4425
4228
|
* @export
|
|
4229
|
+
* @interface ProgramRequest
|
|
4230
|
+
*/
|
|
4231
|
+
export interface ProgramRequest {
|
|
4232
|
+
/**
|
|
4233
|
+
*
|
|
4234
|
+
* @type {string}
|
|
4235
|
+
* @memberof ProgramRequest
|
|
4236
|
+
*/
|
|
4237
|
+
'program'?: string;
|
|
4238
|
+
/**
|
|
4239
|
+
*
|
|
4240
|
+
* @type {string}
|
|
4241
|
+
* @memberof ProgramRequest
|
|
4242
|
+
*/
|
|
4243
|
+
'default_robot'?: string | null;
|
|
4244
|
+
/**
|
|
4245
|
+
*
|
|
4246
|
+
* @type {string}
|
|
4247
|
+
* @memberof ProgramRequest
|
|
4248
|
+
*/
|
|
4249
|
+
'default_tcp'?: string | null;
|
|
4250
|
+
/**
|
|
4251
|
+
* Initial arguments that are available within the program
|
|
4252
|
+
* @type {{ [key: string]: RunArgsValue; }}
|
|
4253
|
+
* @memberof ProgramRequest
|
|
4254
|
+
*/
|
|
4255
|
+
'run_args'?: {
|
|
4256
|
+
[key: string]: RunArgsValue;
|
|
4257
|
+
};
|
|
4258
|
+
}
|
|
4259
|
+
/**
|
|
4260
|
+
* Holds the state of a program run. Args: id: The unique id of the program run state: The state of the program run logs: The logs of the program run stdout: The stdout of the program run store: The store of the program run error: The error message of the program run, if any traceback: The traceback of the program run, if any start_time: The start time of the program run end_time: The end time of the program run execution_results: The robot execution results of the program run
|
|
4261
|
+
* @export
|
|
4426
4262
|
* @interface ProgramRun
|
|
4427
4263
|
*/
|
|
4428
4264
|
export interface ProgramRun {
|
|
4429
4265
|
/**
|
|
4430
|
-
*
|
|
4266
|
+
* Unique id of the program run
|
|
4431
4267
|
* @type {string}
|
|
4432
4268
|
* @memberof ProgramRun
|
|
4433
4269
|
*/
|
|
4434
4270
|
'id': string;
|
|
4435
4271
|
/**
|
|
4436
|
-
*
|
|
4272
|
+
* State of the program run
|
|
4437
4273
|
* @type {ProgramRunState}
|
|
4438
4274
|
* @memberof ProgramRun
|
|
4439
4275
|
*/
|
|
@@ -4443,15 +4279,15 @@ export interface ProgramRun {
|
|
|
4443
4279
|
* @type {string}
|
|
4444
4280
|
* @memberof ProgramRun
|
|
4445
4281
|
*/
|
|
4446
|
-
'logs'?: string;
|
|
4282
|
+
'logs'?: string | null;
|
|
4447
4283
|
/**
|
|
4448
4284
|
*
|
|
4449
4285
|
* @type {string}
|
|
4450
4286
|
* @memberof ProgramRun
|
|
4451
4287
|
*/
|
|
4452
|
-
'stdout'?: string;
|
|
4288
|
+
'stdout'?: string | null;
|
|
4453
4289
|
/**
|
|
4454
|
-
*
|
|
4290
|
+
* Stores runtime variables of the run
|
|
4455
4291
|
* @type {{ [key: string]: StoreValue; }}
|
|
4456
4292
|
* @memberof ProgramRun
|
|
4457
4293
|
*/
|
|
@@ -4483,11 +4319,11 @@ export interface ProgramRun {
|
|
|
4483
4319
|
*/
|
|
4484
4320
|
'end_time'?: number | null;
|
|
4485
4321
|
/**
|
|
4486
|
-
*
|
|
4487
|
-
* @type {Array<
|
|
4322
|
+
* Execution results of the program run
|
|
4323
|
+
* @type {Array<ProgramRunResult>}
|
|
4488
4324
|
* @memberof ProgramRun
|
|
4489
4325
|
*/
|
|
4490
|
-
'execution_results'?: Array<
|
|
4326
|
+
'execution_results'?: Array<ProgramRunResult>;
|
|
4491
4327
|
}
|
|
4492
4328
|
/**
|
|
4493
4329
|
*
|
|
@@ -4535,93 +4371,60 @@ export interface ProgramRunObject {
|
|
|
4535
4371
|
/**
|
|
4536
4372
|
*
|
|
4537
4373
|
* @export
|
|
4538
|
-
* @
|
|
4539
|
-
*/
|
|
4540
|
-
export declare const ProgramRunState: {
|
|
4541
|
-
readonly NotStarted: "not started";
|
|
4542
|
-
readonly Running: "running";
|
|
4543
|
-
readonly Completed: "completed";
|
|
4544
|
-
readonly Failed: "failed";
|
|
4545
|
-
readonly Stopped: "stopped";
|
|
4546
|
-
};
|
|
4547
|
-
export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
|
|
4548
|
-
/**
|
|
4549
|
-
*
|
|
4550
|
-
* @export
|
|
4551
|
-
* @interface ProgramRunnerReference
|
|
4374
|
+
* @interface ProgramRunReference
|
|
4552
4375
|
*/
|
|
4553
|
-
export interface
|
|
4376
|
+
export interface ProgramRunReference {
|
|
4554
4377
|
/**
|
|
4555
4378
|
*
|
|
4556
4379
|
* @type {string}
|
|
4557
|
-
* @memberof
|
|
4380
|
+
* @memberof ProgramRunReference
|
|
4558
4381
|
*/
|
|
4559
4382
|
'id': string;
|
|
4560
4383
|
/**
|
|
4561
4384
|
*
|
|
4562
4385
|
* @type {ProgramRunState}
|
|
4563
|
-
* @memberof
|
|
4386
|
+
* @memberof ProgramRunReference
|
|
4564
4387
|
*/
|
|
4565
4388
|
'state': ProgramRunState;
|
|
4566
4389
|
}
|
|
4567
4390
|
/**
|
|
4568
|
-
*
|
|
4391
|
+
* The ProgramRunResult object contains the execution results of a robot. Arguments: motion_group_id: The unique id of the motion group motion_duration: The total execution duration of the motion group paths: The paths of the motion group as list of Path objects
|
|
4569
4392
|
* @export
|
|
4570
|
-
* @interface
|
|
4393
|
+
* @interface ProgramRunResult
|
|
4571
4394
|
*/
|
|
4572
|
-
export interface
|
|
4573
|
-
/**
|
|
4574
|
-
*
|
|
4575
|
-
* @type {Array<any>}
|
|
4576
|
-
* @memberof PyjectoryDatatypesCorePose
|
|
4577
|
-
*/
|
|
4578
|
-
'position': Array<any>;
|
|
4395
|
+
export interface ProgramRunResult {
|
|
4579
4396
|
/**
|
|
4580
|
-
*
|
|
4581
|
-
* @type {
|
|
4582
|
-
* @memberof
|
|
4397
|
+
* Unique id of the motion group that was executed
|
|
4398
|
+
* @type {string}
|
|
4399
|
+
* @memberof ProgramRunResult
|
|
4583
4400
|
*/
|
|
4584
|
-
'
|
|
4585
|
-
}
|
|
4586
|
-
/**
|
|
4587
|
-
* Rotation vector, defined in [rx, ry, rz] with floating numbers. The rotation is represented in vector3 using an axis-angle representation: axis.normalized * angle (angle in radians). Must be defined for the first pose of a path. If not defined for the rest of the path, the previous orientation will be used.
|
|
4588
|
-
* @export
|
|
4589
|
-
* @interface PyjectoryDatatypesSerializerOrientation
|
|
4590
|
-
*/
|
|
4591
|
-
export interface PyjectoryDatatypesSerializerOrientation {
|
|
4401
|
+
'motion_group_id': string;
|
|
4592
4402
|
/**
|
|
4593
|
-
*
|
|
4594
|
-
* @type {
|
|
4595
|
-
* @memberof
|
|
4403
|
+
* Total execution duration of the motion group
|
|
4404
|
+
* @type {number}
|
|
4405
|
+
* @memberof ProgramRunResult
|
|
4596
4406
|
*/
|
|
4597
|
-
'
|
|
4598
|
-
}
|
|
4599
|
-
/**
|
|
4600
|
-
* Object\'s position and orientaton, defined in [x, y, z, rx, ry, rz]. x,y,z are defined in millimeters. rx,ry,rz are defined in radians.
|
|
4601
|
-
* @export
|
|
4602
|
-
* @interface PyjectoryDatatypesSerializerPose
|
|
4603
|
-
*/
|
|
4604
|
-
export interface PyjectoryDatatypesSerializerPose {
|
|
4407
|
+
'motion_duration': number;
|
|
4605
4408
|
/**
|
|
4606
|
-
*
|
|
4607
|
-
* @type {Array<
|
|
4608
|
-
* @memberof
|
|
4409
|
+
* Paths of the motion group as list of Path objects
|
|
4410
|
+
* @type {Array<Array<RobotState>>}
|
|
4411
|
+
* @memberof ProgramRunResult
|
|
4609
4412
|
*/
|
|
4610
|
-
'
|
|
4413
|
+
'paths': Array<Array<RobotState>>;
|
|
4611
4414
|
}
|
|
4612
4415
|
/**
|
|
4613
|
-
*
|
|
4416
|
+
*
|
|
4614
4417
|
* @export
|
|
4615
|
-
* @
|
|
4418
|
+
* @enum {string}
|
|
4616
4419
|
*/
|
|
4617
|
-
export
|
|
4618
|
-
|
|
4619
|
-
|
|
4620
|
-
|
|
4621
|
-
|
|
4622
|
-
|
|
4623
|
-
|
|
4624
|
-
|
|
4420
|
+
export declare const ProgramRunState: {
|
|
4421
|
+
readonly NotStarted: "not started";
|
|
4422
|
+
readonly Running: "running";
|
|
4423
|
+
readonly Completed: "completed";
|
|
4424
|
+
readonly Failed: "failed";
|
|
4425
|
+
readonly Stopped: "stopped";
|
|
4426
|
+
};
|
|
4427
|
+
export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
|
|
4625
4428
|
/**
|
|
4626
4429
|
* Defines an x-y plane with finite size.
|
|
4627
4430
|
* @export
|
|
@@ -4740,48 +4543,6 @@ export declare const ReleaseChannel: {
|
|
|
4740
4543
|
readonly Next: "next";
|
|
4741
4544
|
};
|
|
4742
4545
|
export type ReleaseChannel = typeof ReleaseChannel[keyof typeof ReleaseChannel];
|
|
4743
|
-
/**
|
|
4744
|
-
* Wandelscript code string which describes a Program as text/plain
|
|
4745
|
-
* @export
|
|
4746
|
-
* @interface Request
|
|
4747
|
-
*/
|
|
4748
|
-
export interface Request {
|
|
4749
|
-
/**
|
|
4750
|
-
* Wandelscript code string which describes a Wandelscript Program as content/json.
|
|
4751
|
-
* @type {string}
|
|
4752
|
-
* @memberof Request
|
|
4753
|
-
*/
|
|
4754
|
-
'code': string;
|
|
4755
|
-
/**
|
|
4756
|
-
*
|
|
4757
|
-
* @type {{ [key: string]: ArrayInputArrayInner; }}
|
|
4758
|
-
* @memberof Request
|
|
4759
|
-
*/
|
|
4760
|
-
'initial_state'?: {
|
|
4761
|
-
[key: string]: ArrayInputArrayInner;
|
|
4762
|
-
};
|
|
4763
|
-
}
|
|
4764
|
-
/**
|
|
4765
|
-
* Wandelscript code string which describes a program
|
|
4766
|
-
* @export
|
|
4767
|
-
* @interface Request1
|
|
4768
|
-
*/
|
|
4769
|
-
export interface Request1 {
|
|
4770
|
-
/**
|
|
4771
|
-
* Wandelscript code string which describes a Wandelscript Program as content/json.
|
|
4772
|
-
* @type {string}
|
|
4773
|
-
* @memberof Request1
|
|
4774
|
-
*/
|
|
4775
|
-
'code': string;
|
|
4776
|
-
/**
|
|
4777
|
-
*
|
|
4778
|
-
* @type {{ [key: string]: ArrayInputArrayInner; }}
|
|
4779
|
-
* @memberof Request1
|
|
4780
|
-
*/
|
|
4781
|
-
'initial_state'?: {
|
|
4782
|
-
[key: string]: ArrayInputArrayInner;
|
|
4783
|
-
};
|
|
4784
|
-
}
|
|
4785
4546
|
/**
|
|
4786
4547
|
* The configuration of a physical or virtual robot controller.
|
|
4787
4548
|
* @export
|
|
@@ -4876,10 +4637,10 @@ export interface RobotLinkGeometry {
|
|
|
4876
4637
|
export interface RobotState {
|
|
4877
4638
|
/**
|
|
4878
4639
|
*
|
|
4879
|
-
* @type {
|
|
4640
|
+
* @type {Pose}
|
|
4880
4641
|
* @memberof RobotState
|
|
4881
4642
|
*/
|
|
4882
|
-
'pose':
|
|
4643
|
+
'pose': Pose;
|
|
4883
4644
|
/**
|
|
4884
4645
|
*
|
|
4885
4646
|
* @type {Array<number>}
|
|
@@ -4950,6 +4711,13 @@ export interface RobotTcps {
|
|
|
4950
4711
|
*/
|
|
4951
4712
|
'tcps': Array<RobotTcp>;
|
|
4952
4713
|
}
|
|
4714
|
+
/**
|
|
4715
|
+
*
|
|
4716
|
+
* @export
|
|
4717
|
+
* @interface RunArgsValue
|
|
4718
|
+
*/
|
|
4719
|
+
export interface RunArgsValue {
|
|
4720
|
+
}
|
|
4953
4721
|
/**
|
|
4954
4722
|
* The safety configuration of a motion-group. Used for motion planning.
|
|
4955
4723
|
* @export
|
|
@@ -5452,41 +5220,17 @@ export interface StartOnIO {
|
|
|
5452
5220
|
*/
|
|
5453
5221
|
export interface StoreValue {
|
|
5454
5222
|
/**
|
|
5455
|
-
*
|
|
5456
|
-
* @type {Array<
|
|
5457
|
-
* @memberof StoreValue
|
|
5458
|
-
*/
|
|
5459
|
-
'pose': Array<any>;
|
|
5460
|
-
/**
|
|
5461
|
-
*
|
|
5462
|
-
* @type {Array<any>}
|
|
5463
|
-
* @memberof StoreValue
|
|
5464
|
-
*/
|
|
5465
|
-
'position': Array<any>;
|
|
5466
|
-
/**
|
|
5467
|
-
*
|
|
5468
|
-
* @type {Array<any>}
|
|
5469
|
-
* @memberof StoreValue
|
|
5470
|
-
*/
|
|
5471
|
-
'orientation': Array<any>;
|
|
5472
|
-
/**
|
|
5473
|
-
*
|
|
5474
|
-
* @type {string}
|
|
5475
|
-
* @memberof StoreValue
|
|
5476
|
-
*/
|
|
5477
|
-
'image': string;
|
|
5478
|
-
/**
|
|
5479
|
-
*
|
|
5480
|
-
* @type {string}
|
|
5223
|
+
* A three-dimensional vector [x, y, z] with double precision.
|
|
5224
|
+
* @type {Array<number>}
|
|
5481
5225
|
* @memberof StoreValue
|
|
5482
5226
|
*/
|
|
5483
|
-
'
|
|
5227
|
+
'position'?: Array<number>;
|
|
5484
5228
|
/**
|
|
5485
|
-
*
|
|
5486
|
-
* @type {Array<
|
|
5229
|
+
* Defines a rotation in 3D space. A three-dimensional Vector [rx, ry, rz] with double precision. Rotation is applied around the vector. The angle of rotation equals the length of the vector.
|
|
5230
|
+
* @type {Array<number>}
|
|
5487
5231
|
* @memberof StoreValue
|
|
5488
5232
|
*/
|
|
5489
|
-
'
|
|
5233
|
+
'orientation'?: Array<number>;
|
|
5490
5234
|
}
|
|
5491
5235
|
/**
|
|
5492
5236
|
* Representing a robot pose in operational space aware of a configured TCP.
|
|
@@ -8737,76 +8481,75 @@ export declare class MotionGroupKinematicsApi extends BaseAPI {
|
|
|
8737
8481
|
*/
|
|
8738
8482
|
export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8739
8483
|
/**
|
|
8740
|
-
* This endpoint accepts a program
|
|
8741
|
-
* @summary Create
|
|
8484
|
+
* This endpoint accepts a program and if desired, initial arguments (in the form of a dict). The program will be executed asynchronously. It returns a program run reference which can be used to query the state of the program run. ## Receiving state updates Receive state updates of the program run via polling the `/programs/runs/{run_id}/` ### Via polling You can receive updates about the state of the program run by polling the `/programs/runs/{run_id}/` endpoint.
|
|
8485
|
+
* @summary Create program run
|
|
8742
8486
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8743
|
-
* @param {
|
|
8487
|
+
* @param {ProgramRequest} programRequest
|
|
8744
8488
|
* @param {*} [options] Override http request option.
|
|
8745
8489
|
* @throws {RequiredError}
|
|
8746
8490
|
*/
|
|
8747
|
-
|
|
8491
|
+
createProgramRun: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8748
8492
|
/**
|
|
8749
|
-
* Execute a program
|
|
8750
|
-
* @summary Execute
|
|
8493
|
+
* Execute a program synchronously. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a successful execution. Otherwise an error (e.g. out of reach, singularity), is returned.
|
|
8494
|
+
* @summary Execute program
|
|
8751
8495
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8752
|
-
* @param {
|
|
8496
|
+
* @param {ProgramRequest} programRequest
|
|
8753
8497
|
* @param {*} [options] Override http request option.
|
|
8754
8498
|
* @throws {RequiredError}
|
|
8755
8499
|
*/
|
|
8756
|
-
executeProgram: (cell: string,
|
|
8500
|
+
executeProgram: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8757
8501
|
/**
|
|
8758
|
-
* Returns information about a program currently executed.
|
|
8759
|
-
* @summary Get
|
|
8502
|
+
* Returns information about a program currently executed. When a program is finished: Program response, result, collected logs, .. When a program is running: Running status, current executed line, ...
|
|
8503
|
+
* @summary Get program run
|
|
8760
8504
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8761
|
-
* @param {string}
|
|
8505
|
+
* @param {string} run
|
|
8762
8506
|
* @param {*} [options] Override http request option.
|
|
8763
8507
|
* @throws {RequiredError}
|
|
8764
8508
|
*/
|
|
8765
|
-
|
|
8509
|
+
getProgramRun: (cell: string, run: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8766
8510
|
/**
|
|
8767
|
-
* Get details about all existing
|
|
8768
|
-
* @summary List
|
|
8511
|
+
* Get details about all existing runs
|
|
8512
|
+
* @summary List programs
|
|
8769
8513
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8770
8514
|
* @param {*} [options] Override http request option.
|
|
8771
8515
|
* @throws {RequiredError}
|
|
8772
8516
|
*/
|
|
8773
|
-
|
|
8517
|
+
getProgramRuns: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8774
8518
|
/**
|
|
8775
|
-
*
|
|
8776
|
-
* @summary
|
|
8519
|
+
* Simulate a program given as text/plain
|
|
8520
|
+
* @summary Simulate program
|
|
8777
8521
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8778
|
-
* @param {
|
|
8522
|
+
* @param {ProgramRequest} programRequest
|
|
8779
8523
|
* @param {*} [options] Override http request option.
|
|
8780
8524
|
* @throws {RequiredError}
|
|
8781
8525
|
*/
|
|
8782
|
-
|
|
8526
|
+
simulateProgram: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8783
8527
|
/**
|
|
8784
|
-
*
|
|
8785
|
-
* @summary
|
|
8528
|
+
* Stop all runs
|
|
8529
|
+
* @summary Stop all programs
|
|
8786
8530
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8787
|
-
* @param {Request} request
|
|
8788
|
-
* @param {string} [identifier]
|
|
8789
8531
|
* @param {*} [options] Override http request option.
|
|
8790
8532
|
* @throws {RequiredError}
|
|
8791
8533
|
*/
|
|
8792
|
-
|
|
8534
|
+
stopAllPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8793
8535
|
/**
|
|
8794
|
-
* Stop
|
|
8795
|
-
* @summary Stop
|
|
8536
|
+
* Stop a specific program run.
|
|
8537
|
+
* @summary Stop program run
|
|
8796
8538
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8539
|
+
* @param {string} run
|
|
8797
8540
|
* @param {*} [options] Override http request option.
|
|
8798
8541
|
* @throws {RequiredError}
|
|
8799
8542
|
*/
|
|
8800
|
-
|
|
8543
|
+
stopProgramRun: (cell: string, run: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8801
8544
|
/**
|
|
8802
|
-
*
|
|
8803
|
-
* @summary
|
|
8545
|
+
* Validate a program
|
|
8546
|
+
* @summary Validate program
|
|
8804
8547
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8805
|
-
* @param {
|
|
8548
|
+
* @param {ProgramRequest} programRequest
|
|
8806
8549
|
* @param {*} [options] Override http request option.
|
|
8807
8550
|
* @throws {RequiredError}
|
|
8808
8551
|
*/
|
|
8809
|
-
|
|
8552
|
+
validateProgram: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8810
8553
|
};
|
|
8811
8554
|
/**
|
|
8812
8555
|
* ProgramApi - functional programming interface
|
|
@@ -8814,76 +8557,75 @@ export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8814
8557
|
*/
|
|
8815
8558
|
export declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
8816
8559
|
/**
|
|
8817
|
-
* This endpoint accepts a program
|
|
8818
|
-
* @summary Create
|
|
8560
|
+
* This endpoint accepts a program and if desired, initial arguments (in the form of a dict). The program will be executed asynchronously. It returns a program run reference which can be used to query the state of the program run. ## Receiving state updates Receive state updates of the program run via polling the `/programs/runs/{run_id}/` ### Via polling You can receive updates about the state of the program run by polling the `/programs/runs/{run_id}/` endpoint.
|
|
8561
|
+
* @summary Create program run
|
|
8819
8562
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8820
|
-
* @param {
|
|
8563
|
+
* @param {ProgramRequest} programRequest
|
|
8821
8564
|
* @param {*} [options] Override http request option.
|
|
8822
8565
|
* @throws {RequiredError}
|
|
8823
8566
|
*/
|
|
8824
|
-
|
|
8567
|
+
createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunReference>>;
|
|
8825
8568
|
/**
|
|
8826
|
-
* Execute a program
|
|
8827
|
-
* @summary Execute
|
|
8569
|
+
* Execute a program synchronously. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a successful execution. Otherwise an error (e.g. out of reach, singularity), is returned.
|
|
8570
|
+
* @summary Execute program
|
|
8828
8571
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8829
|
-
* @param {
|
|
8572
|
+
* @param {ProgramRequest} programRequest
|
|
8830
8573
|
* @param {*} [options] Override http request option.
|
|
8831
8574
|
* @throws {RequiredError}
|
|
8832
8575
|
*/
|
|
8833
|
-
executeProgram(cell: string,
|
|
8576
|
+
executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8834
8577
|
/**
|
|
8835
|
-
* Returns information about a program currently executed.
|
|
8836
|
-
* @summary Get
|
|
8578
|
+
* Returns information about a program currently executed. When a program is finished: Program response, result, collected logs, .. When a program is running: Running status, current executed line, ...
|
|
8579
|
+
* @summary Get program run
|
|
8837
8580
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8838
|
-
* @param {string}
|
|
8581
|
+
* @param {string} run
|
|
8839
8582
|
* @param {*} [options] Override http request option.
|
|
8840
8583
|
* @throws {RequiredError}
|
|
8841
8584
|
*/
|
|
8842
|
-
|
|
8585
|
+
getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8843
8586
|
/**
|
|
8844
|
-
* Get details about all existing
|
|
8845
|
-
* @summary List
|
|
8587
|
+
* Get details about all existing runs
|
|
8588
|
+
* @summary List programs
|
|
8846
8589
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8847
8590
|
* @param {*} [options] Override http request option.
|
|
8848
8591
|
* @throws {RequiredError}
|
|
8849
8592
|
*/
|
|
8850
|
-
|
|
8593
|
+
getProgramRuns(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProgramRunReference>>>;
|
|
8851
8594
|
/**
|
|
8852
|
-
*
|
|
8853
|
-
* @summary
|
|
8595
|
+
* Simulate a program given as text/plain
|
|
8596
|
+
* @summary Simulate program
|
|
8854
8597
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8855
|
-
* @param {
|
|
8598
|
+
* @param {ProgramRequest} programRequest
|
|
8856
8599
|
* @param {*} [options] Override http request option.
|
|
8857
8600
|
* @throws {RequiredError}
|
|
8858
8601
|
*/
|
|
8859
|
-
|
|
8602
|
+
simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8860
8603
|
/**
|
|
8861
|
-
*
|
|
8862
|
-
* @summary
|
|
8604
|
+
* Stop all runs
|
|
8605
|
+
* @summary Stop all programs
|
|
8863
8606
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8864
|
-
* @param {Request} request
|
|
8865
|
-
* @param {string} [identifier]
|
|
8866
8607
|
* @param {*} [options] Override http request option.
|
|
8867
8608
|
* @throws {RequiredError}
|
|
8868
8609
|
*/
|
|
8869
|
-
|
|
8610
|
+
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
8870
8611
|
/**
|
|
8871
|
-
* Stop
|
|
8872
|
-
* @summary Stop
|
|
8612
|
+
* Stop a specific program run.
|
|
8613
|
+
* @summary Stop program run
|
|
8873
8614
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8615
|
+
* @param {string} run
|
|
8874
8616
|
* @param {*} [options] Override http request option.
|
|
8875
8617
|
* @throws {RequiredError}
|
|
8876
8618
|
*/
|
|
8877
|
-
|
|
8619
|
+
stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8878
8620
|
/**
|
|
8879
|
-
*
|
|
8880
|
-
* @summary
|
|
8621
|
+
* Validate a program
|
|
8622
|
+
* @summary Validate program
|
|
8881
8623
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8882
|
-
* @param {
|
|
8624
|
+
* @param {ProgramRequest} programRequest
|
|
8883
8625
|
* @param {*} [options] Override http request option.
|
|
8884
8626
|
* @throws {RequiredError}
|
|
8885
8627
|
*/
|
|
8886
|
-
|
|
8628
|
+
validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8887
8629
|
};
|
|
8888
8630
|
/**
|
|
8889
8631
|
* ProgramApi - factory interface
|
|
@@ -8891,76 +8633,75 @@ export declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
|
8891
8633
|
*/
|
|
8892
8634
|
export declare const ProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8893
8635
|
/**
|
|
8894
|
-
* This endpoint accepts a program
|
|
8895
|
-
* @summary Create
|
|
8636
|
+
* This endpoint accepts a program and if desired, initial arguments (in the form of a dict). The program will be executed asynchronously. It returns a program run reference which can be used to query the state of the program run. ## Receiving state updates Receive state updates of the program run via polling the `/programs/runs/{run_id}/` ### Via polling You can receive updates about the state of the program run by polling the `/programs/runs/{run_id}/` endpoint.
|
|
8637
|
+
* @summary Create program run
|
|
8896
8638
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8897
|
-
* @param {
|
|
8639
|
+
* @param {ProgramRequest} programRequest
|
|
8898
8640
|
* @param {*} [options] Override http request option.
|
|
8899
8641
|
* @throws {RequiredError}
|
|
8900
8642
|
*/
|
|
8901
|
-
|
|
8643
|
+
createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunReference>;
|
|
8902
8644
|
/**
|
|
8903
|
-
* Execute a program
|
|
8904
|
-
* @summary Execute
|
|
8645
|
+
* Execute a program synchronously. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a successful execution. Otherwise an error (e.g. out of reach, singularity), is returned.
|
|
8646
|
+
* @summary Execute program
|
|
8905
8647
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8906
|
-
* @param {
|
|
8648
|
+
* @param {ProgramRequest} programRequest
|
|
8907
8649
|
* @param {*} [options] Override http request option.
|
|
8908
8650
|
* @throws {RequiredError}
|
|
8909
8651
|
*/
|
|
8910
|
-
executeProgram(cell: string,
|
|
8652
|
+
executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8911
8653
|
/**
|
|
8912
|
-
* Returns information about a program currently executed.
|
|
8913
|
-
* @summary Get
|
|
8654
|
+
* Returns information about a program currently executed. When a program is finished: Program response, result, collected logs, .. When a program is running: Running status, current executed line, ...
|
|
8655
|
+
* @summary Get program run
|
|
8914
8656
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8915
|
-
* @param {string}
|
|
8657
|
+
* @param {string} run
|
|
8916
8658
|
* @param {*} [options] Override http request option.
|
|
8917
8659
|
* @throws {RequiredError}
|
|
8918
8660
|
*/
|
|
8919
|
-
|
|
8661
|
+
getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8920
8662
|
/**
|
|
8921
|
-
* Get details about all existing
|
|
8922
|
-
* @summary List
|
|
8663
|
+
* Get details about all existing runs
|
|
8664
|
+
* @summary List programs
|
|
8923
8665
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8924
8666
|
* @param {*} [options] Override http request option.
|
|
8925
8667
|
* @throws {RequiredError}
|
|
8926
8668
|
*/
|
|
8927
|
-
|
|
8669
|
+
getProgramRuns(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProgramRunReference>>;
|
|
8928
8670
|
/**
|
|
8929
|
-
*
|
|
8930
|
-
* @summary
|
|
8671
|
+
* Simulate a program given as text/plain
|
|
8672
|
+
* @summary Simulate program
|
|
8931
8673
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8932
|
-
* @param {
|
|
8674
|
+
* @param {ProgramRequest} programRequest
|
|
8933
8675
|
* @param {*} [options] Override http request option.
|
|
8934
8676
|
* @throws {RequiredError}
|
|
8935
8677
|
*/
|
|
8936
|
-
|
|
8678
|
+
simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8937
8679
|
/**
|
|
8938
|
-
*
|
|
8939
|
-
* @summary
|
|
8680
|
+
* Stop all runs
|
|
8681
|
+
* @summary Stop all programs
|
|
8940
8682
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8941
|
-
* @param {Request} request
|
|
8942
|
-
* @param {string} [identifier]
|
|
8943
8683
|
* @param {*} [options] Override http request option.
|
|
8944
8684
|
* @throws {RequiredError}
|
|
8945
8685
|
*/
|
|
8946
|
-
|
|
8686
|
+
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
8947
8687
|
/**
|
|
8948
|
-
* Stop
|
|
8949
|
-
* @summary Stop
|
|
8688
|
+
* Stop a specific program run.
|
|
8689
|
+
* @summary Stop program run
|
|
8950
8690
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8691
|
+
* @param {string} run
|
|
8951
8692
|
* @param {*} [options] Override http request option.
|
|
8952
8693
|
* @throws {RequiredError}
|
|
8953
8694
|
*/
|
|
8954
|
-
|
|
8695
|
+
stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8955
8696
|
/**
|
|
8956
|
-
*
|
|
8957
|
-
* @summary
|
|
8697
|
+
* Validate a program
|
|
8698
|
+
* @summary Validate program
|
|
8958
8699
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8959
|
-
* @param {
|
|
8700
|
+
* @param {ProgramRequest} programRequest
|
|
8960
8701
|
* @param {*} [options] Override http request option.
|
|
8961
8702
|
* @throws {RequiredError}
|
|
8962
8703
|
*/
|
|
8963
|
-
|
|
8704
|
+
validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8964
8705
|
};
|
|
8965
8706
|
/**
|
|
8966
8707
|
* ProgramApi - object-oriented interface
|
|
@@ -8970,84 +8711,83 @@ export declare const ProgramApiFactory: (configuration?: Configuration, basePath
|
|
|
8970
8711
|
*/
|
|
8971
8712
|
export declare class ProgramApi extends BaseAPI {
|
|
8972
8713
|
/**
|
|
8973
|
-
* This endpoint accepts a program
|
|
8974
|
-
* @summary Create
|
|
8714
|
+
* This endpoint accepts a program and if desired, initial arguments (in the form of a dict). The program will be executed asynchronously. It returns a program run reference which can be used to query the state of the program run. ## Receiving state updates Receive state updates of the program run via polling the `/programs/runs/{run_id}/` ### Via polling You can receive updates about the state of the program run by polling the `/programs/runs/{run_id}/` endpoint.
|
|
8715
|
+
* @summary Create program run
|
|
8975
8716
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8976
|
-
* @param {
|
|
8717
|
+
* @param {ProgramRequest} programRequest
|
|
8977
8718
|
* @param {*} [options] Override http request option.
|
|
8978
8719
|
* @throws {RequiredError}
|
|
8979
8720
|
* @memberof ProgramApi
|
|
8980
8721
|
*/
|
|
8981
|
-
|
|
8722
|
+
createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunReference, any>>;
|
|
8982
8723
|
/**
|
|
8983
|
-
* Execute a program
|
|
8984
|
-
* @summary Execute
|
|
8724
|
+
* Execute a program synchronously. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a successful execution. Otherwise an error (e.g. out of reach, singularity), is returned.
|
|
8725
|
+
* @summary Execute program
|
|
8985
8726
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8986
|
-
* @param {
|
|
8727
|
+
* @param {ProgramRequest} programRequest
|
|
8987
8728
|
* @param {*} [options] Override http request option.
|
|
8988
8729
|
* @throws {RequiredError}
|
|
8989
8730
|
* @memberof ProgramApi
|
|
8990
8731
|
*/
|
|
8991
|
-
executeProgram(cell: string,
|
|
8732
|
+
executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
8992
8733
|
/**
|
|
8993
|
-
* Returns information about a program currently executed.
|
|
8994
|
-
* @summary Get
|
|
8734
|
+
* Returns information about a program currently executed. When a program is finished: Program response, result, collected logs, .. When a program is running: Running status, current executed line, ...
|
|
8735
|
+
* @summary Get program run
|
|
8995
8736
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8996
|
-
* @param {string}
|
|
8737
|
+
* @param {string} run
|
|
8997
8738
|
* @param {*} [options] Override http request option.
|
|
8998
8739
|
* @throws {RequiredError}
|
|
8999
8740
|
* @memberof ProgramApi
|
|
9000
8741
|
*/
|
|
9001
|
-
|
|
8742
|
+
getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
9002
8743
|
/**
|
|
9003
|
-
* Get details about all existing
|
|
9004
|
-
* @summary List
|
|
8744
|
+
* Get details about all existing runs
|
|
8745
|
+
* @summary List programs
|
|
9005
8746
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9006
8747
|
* @param {*} [options] Override http request option.
|
|
9007
8748
|
* @throws {RequiredError}
|
|
9008
8749
|
* @memberof ProgramApi
|
|
9009
8750
|
*/
|
|
9010
|
-
|
|
8751
|
+
getProgramRuns(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunReference[], any>>;
|
|
9011
8752
|
/**
|
|
9012
|
-
*
|
|
9013
|
-
* @summary
|
|
8753
|
+
* Simulate a program given as text/plain
|
|
8754
|
+
* @summary Simulate program
|
|
9014
8755
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9015
|
-
* @param {
|
|
8756
|
+
* @param {ProgramRequest} programRequest
|
|
9016
8757
|
* @param {*} [options] Override http request option.
|
|
9017
8758
|
* @throws {RequiredError}
|
|
9018
8759
|
* @memberof ProgramApi
|
|
9019
8760
|
*/
|
|
9020
|
-
|
|
8761
|
+
simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
9021
8762
|
/**
|
|
9022
|
-
*
|
|
9023
|
-
* @summary
|
|
8763
|
+
* Stop all runs
|
|
8764
|
+
* @summary Stop all programs
|
|
9024
8765
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9025
|
-
* @param {Request} request
|
|
9026
|
-
* @param {string} [identifier]
|
|
9027
8766
|
* @param {*} [options] Override http request option.
|
|
9028
8767
|
* @throws {RequiredError}
|
|
9029
8768
|
* @memberof ProgramApi
|
|
9030
8769
|
*/
|
|
9031
|
-
|
|
8770
|
+
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
9032
8771
|
/**
|
|
9033
|
-
* Stop
|
|
9034
|
-
* @summary Stop
|
|
8772
|
+
* Stop a specific program run.
|
|
8773
|
+
* @summary Stop program run
|
|
9035
8774
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8775
|
+
* @param {string} run
|
|
9036
8776
|
* @param {*} [options] Override http request option.
|
|
9037
8777
|
* @throws {RequiredError}
|
|
9038
8778
|
* @memberof ProgramApi
|
|
9039
8779
|
*/
|
|
9040
|
-
|
|
8780
|
+
stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9041
8781
|
/**
|
|
9042
|
-
*
|
|
9043
|
-
* @summary
|
|
8782
|
+
* Validate a program
|
|
8783
|
+
* @summary Validate program
|
|
9044
8784
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9045
|
-
* @param {
|
|
8785
|
+
* @param {ProgramRequest} programRequest
|
|
9046
8786
|
* @param {*} [options] Override http request option.
|
|
9047
8787
|
* @throws {RequiredError}
|
|
9048
8788
|
* @memberof ProgramApi
|
|
9049
8789
|
*/
|
|
9050
|
-
|
|
8790
|
+
validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9051
8791
|
}
|
|
9052
8792
|
/**
|
|
9053
8793
|
* ProgramOperatorApi - axios parameter creator
|
|
@@ -9055,14 +8795,14 @@ export declare class ProgramApi extends BaseAPI {
|
|
|
9055
8795
|
*/
|
|
9056
8796
|
export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
9057
8797
|
/**
|
|
9058
|
-
* <!-- theme: danger -->
|
|
8798
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
|
|
9059
8799
|
* @summary Run Program from Library
|
|
9060
8800
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9061
|
-
* @param {
|
|
8801
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
9062
8802
|
* @param {*} [options] Override http request option.
|
|
9063
8803
|
* @throws {RequiredError}
|
|
9064
8804
|
*/
|
|
9065
|
-
|
|
8805
|
+
createProgramOperatorRun: (cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9066
8806
|
/**
|
|
9067
8807
|
* <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
|
|
9068
8808
|
* @summary Create Trigger
|
|
@@ -9082,14 +8822,14 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
|
|
|
9082
8822
|
*/
|
|
9083
8823
|
deleteTrigger: (trigger: string, cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9084
8824
|
/**
|
|
9085
|
-
* <!-- theme: danger -->
|
|
8825
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
9086
8826
|
* @summary Get All Program Runs
|
|
9087
8827
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9088
8828
|
* @param {string} [state]
|
|
9089
8829
|
* @param {*} [options] Override http request option.
|
|
9090
8830
|
* @throws {RequiredError}
|
|
9091
8831
|
*/
|
|
9092
|
-
|
|
8832
|
+
getAllProgramOperatorRuns: (cell: string, state?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9093
8833
|
/**
|
|
9094
8834
|
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
|
|
9095
8835
|
* @summary Get All Triggers
|
|
@@ -9099,14 +8839,14 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
|
|
|
9099
8839
|
*/
|
|
9100
8840
|
getAllTriggers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9101
8841
|
/**
|
|
9102
|
-
* <!-- theme: danger -->
|
|
8842
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
9103
8843
|
* @summary Get Program Run
|
|
9104
8844
|
* @param {string} run
|
|
9105
8845
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9106
8846
|
* @param {*} [options] Override http request option.
|
|
9107
8847
|
* @throws {RequiredError}
|
|
9108
8848
|
*/
|
|
9109
|
-
|
|
8849
|
+
getProgramOperatorRun: (run: string, cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9110
8850
|
/**
|
|
9111
8851
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
9112
8852
|
* @summary Get Trigger
|
|
@@ -9133,14 +8873,14 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
|
|
|
9133
8873
|
*/
|
|
9134
8874
|
export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
|
|
9135
8875
|
/**
|
|
9136
|
-
* <!-- theme: danger -->
|
|
8876
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
|
|
9137
8877
|
* @summary Run Program from Library
|
|
9138
8878
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9139
|
-
* @param {
|
|
8879
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
9140
8880
|
* @param {*} [options] Override http request option.
|
|
9141
8881
|
* @throws {RequiredError}
|
|
9142
8882
|
*/
|
|
9143
|
-
|
|
8883
|
+
createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProgramOperatorRun200Response>>;
|
|
9144
8884
|
/**
|
|
9145
8885
|
* <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
|
|
9146
8886
|
* @summary Create Trigger
|
|
@@ -9160,14 +8900,14 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
|
|
|
9160
8900
|
*/
|
|
9161
8901
|
deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9162
8902
|
/**
|
|
9163
|
-
* <!-- theme: danger -->
|
|
8903
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
9164
8904
|
* @summary Get All Program Runs
|
|
9165
8905
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9166
8906
|
* @param {string} [state]
|
|
9167
8907
|
* @param {*} [options] Override http request option.
|
|
9168
8908
|
* @throws {RequiredError}
|
|
9169
8909
|
*/
|
|
9170
|
-
|
|
8910
|
+
getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllProgramOperatorRuns200Response>>;
|
|
9171
8911
|
/**
|
|
9172
8912
|
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
|
|
9173
8913
|
* @summary Get All Triggers
|
|
@@ -9177,14 +8917,14 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
|
|
|
9177
8917
|
*/
|
|
9178
8918
|
getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllTriggers200Response>>;
|
|
9179
8919
|
/**
|
|
9180
|
-
* <!-- theme: danger -->
|
|
8920
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
9181
8921
|
* @summary Get Program Run
|
|
9182
8922
|
* @param {string} run
|
|
9183
8923
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9184
8924
|
* @param {*} [options] Override http request option.
|
|
9185
8925
|
* @throws {RequiredError}
|
|
9186
8926
|
*/
|
|
9187
|
-
|
|
8927
|
+
getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunObject>>;
|
|
9188
8928
|
/**
|
|
9189
8929
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
9190
8930
|
* @summary Get Trigger
|
|
@@ -9211,14 +8951,14 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
|
|
|
9211
8951
|
*/
|
|
9212
8952
|
export declare const ProgramOperatorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9213
8953
|
/**
|
|
9214
|
-
* <!-- theme: danger -->
|
|
8954
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
|
|
9215
8955
|
* @summary Run Program from Library
|
|
9216
8956
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9217
|
-
* @param {
|
|
8957
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
9218
8958
|
* @param {*} [options] Override http request option.
|
|
9219
8959
|
* @throws {RequiredError}
|
|
9220
8960
|
*/
|
|
9221
|
-
|
|
8961
|
+
createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateProgramOperatorRun200Response>;
|
|
9222
8962
|
/**
|
|
9223
8963
|
* <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
|
|
9224
8964
|
* @summary Create Trigger
|
|
@@ -9238,14 +8978,14 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
|
|
|
9238
8978
|
*/
|
|
9239
8979
|
deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
9240
8980
|
/**
|
|
9241
|
-
* <!-- theme: danger -->
|
|
8981
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
9242
8982
|
* @summary Get All Program Runs
|
|
9243
8983
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9244
8984
|
* @param {string} [state]
|
|
9245
8985
|
* @param {*} [options] Override http request option.
|
|
9246
8986
|
* @throws {RequiredError}
|
|
9247
8987
|
*/
|
|
9248
|
-
|
|
8988
|
+
getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllProgramOperatorRuns200Response>;
|
|
9249
8989
|
/**
|
|
9250
8990
|
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
|
|
9251
8991
|
* @summary Get All Triggers
|
|
@@ -9255,14 +8995,14 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
|
|
|
9255
8995
|
*/
|
|
9256
8996
|
getAllTriggers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllTriggers200Response>;
|
|
9257
8997
|
/**
|
|
9258
|
-
* <!-- theme: danger -->
|
|
8998
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
9259
8999
|
* @summary Get Program Run
|
|
9260
9000
|
* @param {string} run
|
|
9261
9001
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9262
9002
|
* @param {*} [options] Override http request option.
|
|
9263
9003
|
* @throws {RequiredError}
|
|
9264
9004
|
*/
|
|
9265
|
-
|
|
9005
|
+
getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunObject>;
|
|
9266
9006
|
/**
|
|
9267
9007
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
9268
9008
|
* @summary Get Trigger
|
|
@@ -9291,15 +9031,15 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
|
|
|
9291
9031
|
*/
|
|
9292
9032
|
export declare class ProgramOperatorApi extends BaseAPI {
|
|
9293
9033
|
/**
|
|
9294
|
-
* <!-- theme: danger -->
|
|
9034
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
|
|
9295
9035
|
* @summary Run Program from Library
|
|
9296
9036
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9297
|
-
* @param {
|
|
9037
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
9298
9038
|
* @param {*} [options] Override http request option.
|
|
9299
9039
|
* @throws {RequiredError}
|
|
9300
9040
|
* @memberof ProgramOperatorApi
|
|
9301
9041
|
*/
|
|
9302
|
-
|
|
9042
|
+
createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateProgramOperatorRun200Response, any>>;
|
|
9303
9043
|
/**
|
|
9304
9044
|
* <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
|
|
9305
9045
|
* @summary Create Trigger
|
|
@@ -9321,7 +9061,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
|
|
|
9321
9061
|
*/
|
|
9322
9062
|
deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9323
9063
|
/**
|
|
9324
|
-
* <!-- theme: danger -->
|
|
9064
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
9325
9065
|
* @summary Get All Program Runs
|
|
9326
9066
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9327
9067
|
* @param {string} [state]
|
|
@@ -9329,7 +9069,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
|
|
|
9329
9069
|
* @throws {RequiredError}
|
|
9330
9070
|
* @memberof ProgramOperatorApi
|
|
9331
9071
|
*/
|
|
9332
|
-
|
|
9072
|
+
getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllProgramOperatorRuns200Response, any>>;
|
|
9333
9073
|
/**
|
|
9334
9074
|
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
|
|
9335
9075
|
* @summary Get All Triggers
|
|
@@ -9340,7 +9080,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
|
|
|
9340
9080
|
*/
|
|
9341
9081
|
getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllTriggers200Response, any>>;
|
|
9342
9082
|
/**
|
|
9343
|
-
* <!-- theme: danger -->
|
|
9083
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
9344
9084
|
* @summary Get Program Run
|
|
9345
9085
|
* @param {string} run
|
|
9346
9086
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
@@ -9348,7 +9088,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
|
|
|
9348
9088
|
* @throws {RequiredError}
|
|
9349
9089
|
* @memberof ProgramOperatorApi
|
|
9350
9090
|
*/
|
|
9351
|
-
|
|
9091
|
+
getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunObject, any>>;
|
|
9352
9092
|
/**
|
|
9353
9093
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
9354
9094
|
* @summary Get Trigger
|