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