@uipath/integrationservice-tool 0.9.1 → 1.0.4
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/README.md +33 -17
- package/dist/index.js +1 -1
- package/dist/tool.js +33087 -99168
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -41,11 +41,17 @@ Manage connections to external services:
|
|
|
41
41
|
|
|
42
42
|
```bash
|
|
43
43
|
# List connections for a connector
|
|
44
|
-
uip is connections list <connector-key> [--folder-key <key>]
|
|
44
|
+
uip is connections list <connector-key> [--folder <key>] [--folder-key <key>]
|
|
45
|
+
|
|
46
|
+
# Export connections for audit
|
|
47
|
+
uip is connections export
|
|
45
48
|
|
|
46
49
|
# Ping a connection to check if it's active
|
|
47
50
|
uip is connections ping <connection-id>
|
|
48
51
|
|
|
52
|
+
# Delete a connection
|
|
53
|
+
uip is connections delete <connection-id>
|
|
54
|
+
|
|
49
55
|
# Create a new connection (OAuth flow)
|
|
50
56
|
uip is connections create <connector-key>
|
|
51
57
|
|
|
@@ -54,19 +60,25 @@ uip is connections edit <connection-id>
|
|
|
54
60
|
|
|
55
61
|
# Examples
|
|
56
62
|
uip is connections list uipath-outlook-365
|
|
57
|
-
uip is connections list uipath-salesforce-sfdc --folder
|
|
63
|
+
uip is connections list uipath-salesforce-sfdc --folder my-folder-key
|
|
64
|
+
uip is connections export
|
|
58
65
|
uip is connections ping 73ca047b-24dd-4789-a37e-e7afb67654cd
|
|
66
|
+
uip is connections delete 73ca047b-24dd-4789-a37e-e7afb67654cd
|
|
59
67
|
uip is connections create uipath-doist-todoist
|
|
60
68
|
uip is connections create uipath-zoho-desk --no-browser
|
|
69
|
+
uip is connections create uipath-zoho-desk --no-browser --no-wait
|
|
61
70
|
uip is connections edit 73ca047b-24dd-4789-a37e-e7afb67654cd
|
|
71
|
+
uip is connections edit 73ca047b-24dd-4789-a37e-e7afb67654cd --no-browser --no-wait
|
|
62
72
|
```
|
|
63
73
|
|
|
64
74
|
**Available Options:**
|
|
75
|
+
- `--folder <key>` - Alias for `--folder-key` (optional, for list command only)
|
|
65
76
|
- `--folder-key <key>` - Filter connections by folder key (optional, for list command only)
|
|
66
77
|
- `-t, --tenant <name>` - Specify tenant (optional)
|
|
67
78
|
- `--output <format>` - Output format: table, json, yaml, plain (default: table)
|
|
68
79
|
- `--refresh` - Force re-fetch from API, ignoring cache (for list command only)
|
|
69
80
|
- `--no-browser` - Don't auto-open browser (for create/edit commands only)
|
|
81
|
+
- `--no-wait` - Return pending authorization details without polling (for create/edit commands only)
|
|
70
82
|
|
|
71
83
|
**Connection States:**
|
|
72
84
|
|
|
@@ -84,6 +96,10 @@ When listing connections, the output includes a `State` field. Only `Enabled` co
|
|
|
84
96
|
3. Polls session status every 5 seconds
|
|
85
97
|
4. Shows connection details on success
|
|
86
98
|
|
|
99
|
+
For headless scripts, pass `--no-browser --no-wait` to return a structured
|
|
100
|
+
`ConnectionAuthorizationPending` result with the authorization URL and session
|
|
101
|
+
details instead of polling the browser-based OAuth flow.
|
|
102
|
+
|
|
87
103
|
**Connection Ping:**
|
|
88
104
|
|
|
89
105
|
Check if a connection is active before performing operations:
|
|
@@ -198,16 +214,16 @@ uip is resources describe uipath-salesforce-sfdc Account --connection-id <id> --
|
|
|
198
214
|
- `-t, --tenant <name>` - Specify tenant (optional)
|
|
199
215
|
- `--output <format>` - Output format: table, json, yaml, plain (default: json)
|
|
200
216
|
|
|
201
|
-
####
|
|
217
|
+
#### Run Data Operations
|
|
202
218
|
|
|
203
|
-
|
|
219
|
+
Run CRUD operations against live data through a connection. The `run` subgroup provides verb-based subcommands with a consistent signature:
|
|
204
220
|
|
|
205
221
|
```
|
|
206
|
-
uip is resources
|
|
222
|
+
uip is resources run <verb> <connector-key> <object-name> --connection-id <id> [options]
|
|
207
223
|
```
|
|
208
224
|
|
|
209
225
|
```
|
|
210
|
-
uip is resources
|
|
226
|
+
uip is resources run --help
|
|
211
227
|
|
|
212
228
|
Commands:
|
|
213
229
|
create <connector-key> <object-name> Create a new record
|
|
@@ -220,32 +236,32 @@ Commands:
|
|
|
220
236
|
|
|
221
237
|
**Create a record:**
|
|
222
238
|
```bash
|
|
223
|
-
uip is resources
|
|
239
|
+
uip is resources run create uipath-zoho-desk tickets \
|
|
224
240
|
--connection-id <id> \
|
|
225
241
|
--body '{"subject":"New ticket","priority":"High"}'
|
|
226
242
|
```
|
|
227
243
|
|
|
228
244
|
**List all records:**
|
|
229
245
|
```bash
|
|
230
|
-
uip is resources
|
|
246
|
+
uip is resources run list uipath-zoho-desk tickets \
|
|
231
247
|
--connection-id <id>
|
|
232
248
|
|
|
233
249
|
# With query parameters
|
|
234
|
-
uip is resources
|
|
250
|
+
uip is resources run list uipath-zoho-desk tickets \
|
|
235
251
|
--connection-id <id> \
|
|
236
252
|
--query "limit=10&offset=0"
|
|
237
253
|
```
|
|
238
254
|
|
|
239
255
|
**Get a record by ID:**
|
|
240
256
|
```bash
|
|
241
|
-
uip is resources
|
|
257
|
+
uip is resources run get uipath-zoho-desk tickets \
|
|
242
258
|
--connection-id <id> \
|
|
243
259
|
--query "id=123"
|
|
244
260
|
```
|
|
245
261
|
|
|
246
262
|
**Update a record:**
|
|
247
263
|
```bash
|
|
248
|
-
uip is resources
|
|
264
|
+
uip is resources run update uipath-zoho-desk tickets \
|
|
249
265
|
--connection-id <id> \
|
|
250
266
|
--body '{"status":"closed"}' \
|
|
251
267
|
--query "id=123"
|
|
@@ -253,19 +269,19 @@ uip is resources execute update uipath-zoho-desk tickets \
|
|
|
253
269
|
|
|
254
270
|
**Replace a record:**
|
|
255
271
|
```bash
|
|
256
|
-
uip is resources
|
|
272
|
+
uip is resources run replace uipath-zoho-desk tickets \
|
|
257
273
|
--connection-id <id> \
|
|
258
274
|
--body '{"subject":"Replaced ticket","priority":"Low"}'
|
|
259
275
|
```
|
|
260
276
|
|
|
261
277
|
**Delete a record:**
|
|
262
278
|
```bash
|
|
263
|
-
uip is resources
|
|
279
|
+
uip is resources run delete uipath-zoho-desk tickets \
|
|
264
280
|
--connection-id <id> \
|
|
265
281
|
--query "id=123"
|
|
266
282
|
```
|
|
267
283
|
|
|
268
|
-
**Available Options (all
|
|
284
|
+
**Available Options (all run subcommands):**
|
|
269
285
|
- `--connection-id <id>` - Connection/Instance ID (required)
|
|
270
286
|
- `--body <json>` - Request body as JSON string (required for create, update, replace)
|
|
271
287
|
- `--query <params>` - Query parameters as key=value pairs, separated by `&`
|
|
@@ -322,12 +338,12 @@ uip is resources list uipath-salesforce-sfdc --connection-id <connection-id> --o
|
|
|
322
338
|
uip is resources describe uipath-salesforce-sfdc accounts --connection-id <connection-id> --operation Create
|
|
323
339
|
|
|
324
340
|
# 9. Create a record
|
|
325
|
-
uip is resources
|
|
341
|
+
uip is resources run create uipath-salesforce-sfdc accounts \
|
|
326
342
|
--connection-id <connection-id> \
|
|
327
343
|
--body '{"Name":"Acme Corporation","Industry":"Technology"}'
|
|
328
344
|
|
|
329
345
|
# 10. List records
|
|
330
|
-
uip is resources
|
|
346
|
+
uip is resources run list uipath-salesforce-sfdc accounts \
|
|
331
347
|
--connection-id <connection-id>
|
|
332
348
|
|
|
333
349
|
# 11. List activities for workflow design
|
|
@@ -474,7 +490,7 @@ The tool interacts with these Integration Service APIs:
|
|
|
474
490
|
| `activities list` | `GET /elements_/v3/element/elements/{key}/activities` |
|
|
475
491
|
| `resources list` | `GET /elements_/v3/element/[instances/{id}/]elements/{key}/objects` |
|
|
476
492
|
| `resources describe` | `GET /elements_/v3/element/[instances/{id}/]elements/{key}/objects/{name}/metadata` |
|
|
477
|
-
| `resources
|
|
493
|
+
| `resources run *` | `{METHOD} /elements_/v3/element/instances/{id}/{objectName}` |
|
|
478
494
|
|
|
479
495
|
---
|
|
480
496
|
|
package/dist/index.js
CHANGED