aspera-cli 4.27.1 → 4.27.3

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.
Files changed (133) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/CHANGELOG.md +67 -1
  4. data/bin/ascli +2 -1
  5. data/docs/README.md +805 -747
  6. data/lib/aspera/agent/connect.rb +6 -4
  7. data/lib/aspera/agent/desktop.rb +2 -2
  8. data/lib/aspera/agent/direct.rb +3 -1
  9. data/lib/aspera/agent/node.rb +3 -3
  10. data/lib/aspera/api/alee.rb +1 -1
  11. data/lib/aspera/api/aoc.rb +14 -12
  12. data/lib/aspera/api/ats.rb +1 -1
  13. data/lib/aspera/api/cos_node.rb +2 -2
  14. data/lib/aspera/api/faspex.rb +9 -7
  15. data/lib/aspera/api/httpgw.rb +37 -33
  16. data/lib/aspera/api/node.rb +38 -33
  17. data/lib/aspera/ascmd.rb +3 -1
  18. data/lib/aspera/ascp/installation.rb +62 -27
  19. data/lib/aspera/ascp/management.rb +1 -0
  20. data/lib/aspera/assert.rb +4 -0
  21. data/lib/aspera/cli/ascp_actions.rb +20 -41
  22. data/lib/aspera/cli/async_transfer_store.rb +2 -2
  23. data/lib/aspera/cli/bootstrapper.rb +11 -15
  24. data/lib/aspera/cli/command_line.rb +252 -0
  25. data/lib/aspera/cli/command_registry.rb +149 -33
  26. data/lib/aspera/cli/command_spec.rb +103 -14
  27. data/lib/aspera/cli/completion/ascli.bash +12 -0
  28. data/lib/aspera/cli/completion/ascli.fish +16 -0
  29. data/lib/aspera/cli/completion/ascli.zsh +19 -0
  30. data/lib/aspera/cli/context.rb +3 -0
  31. data/lib/aspera/cli/deprecation.rb +37 -0
  32. data/lib/aspera/cli/extended_value.rb +2 -0
  33. data/lib/aspera/cli/formatter.rb +87 -75
  34. data/lib/aspera/cli/gem_checker.rb +1 -1
  35. data/lib/aspera/cli/hints.rb +7 -6
  36. data/lib/aspera/cli/http.rb +21 -21
  37. data/lib/aspera/cli/info.rb +3 -0
  38. data/lib/aspera/cli/mcp_tool.rb +47 -83
  39. data/lib/aspera/cli/option_declarator.rb +33 -42
  40. data/lib/aspera/cli/option_registry.rb +69 -0
  41. data/lib/aspera/cli/option_types.rb +103 -0
  42. data/lib/aspera/cli/option_value.rb +281 -0
  43. data/lib/aspera/cli/options.schema.yaml +38 -5
  44. data/lib/aspera/cli/parser.rb +307 -848
  45. data/lib/aspera/cli/plugins/alee.rb +7 -4
  46. data/lib/aspera/cli/plugins/aoc.rb +435 -380
  47. data/lib/aspera/cli/plugins/ats.rb +58 -73
  48. data/lib/aspera/cli/plugins/base.rb +190 -240
  49. data/lib/aspera/cli/plugins/basic_auth.rb +2 -10
  50. data/lib/aspera/cli/plugins/config.rb +244 -178
  51. data/lib/aspera/cli/plugins/console.rb +102 -38
  52. data/lib/aspera/cli/plugins/cos.rb +6 -23
  53. data/lib/aspera/cli/plugins/factory.rb +3 -0
  54. data/lib/aspera/cli/plugins/faspex5.rb +176 -173
  55. data/lib/aspera/cli/plugins/faspio.rb +5 -10
  56. data/lib/aspera/cli/plugins/httpgw.rb +8 -11
  57. data/lib/aspera/cli/plugins/mcp.rb +20 -55
  58. data/lib/aspera/cli/plugins/node.rb +277 -311
  59. data/lib/aspera/cli/plugins/orchestrator.rb +90 -77
  60. data/lib/aspera/cli/plugins/preview.rb +79 -90
  61. data/lib/aspera/cli/plugins/server.rb +76 -50
  62. data/lib/aspera/cli/plugins/shares.rb +68 -116
  63. data/lib/aspera/cli/preset_actions.rb +17 -10
  64. data/lib/aspera/cli/preset_manager.rb +12 -2
  65. data/lib/aspera/cli/prompt.rb +35 -0
  66. data/lib/aspera/cli/result.rb +13 -18
  67. data/lib/aspera/cli/runner.rb +31 -54
  68. data/lib/aspera/cli/special_values.rb +5 -0
  69. data/lib/aspera/cli/sync_actions.rb +41 -37
  70. data/lib/aspera/cli/terminal_formatter.rb +9 -3
  71. data/lib/aspera/cli/transfer_actions.rb +0 -6
  72. data/lib/aspera/cli/transfer_agent.rb +29 -35
  73. data/lib/aspera/cli/vault_manager.rb +0 -17
  74. data/lib/aspera/cli/version.rb +1 -1
  75. data/lib/aspera/cli/wizard.rb +4 -2
  76. data/lib/aspera/command_line_builder.rb +1 -0
  77. data/lib/aspera/coverage.rb +1 -0
  78. data/lib/aspera/environment.rb +7 -1
  79. data/lib/aspera/faspex_gw.rb +2 -1
  80. data/lib/aspera/faspex_postproc.rb +1 -0
  81. data/lib/aspera/graphql.rb +5 -5
  82. data/lib/aspera/json_rpc/client.rb +5 -5
  83. data/lib/aspera/keychain/encrypted_hash.rb +1 -1
  84. data/lib/aspera/keychain/one_password_api.rb +1 -1
  85. data/lib/aspera/link_header.rb +2 -2
  86. data/lib/aspera/log.rb +22 -25
  87. data/lib/aspera/markdown.rb +2 -0
  88. data/lib/aspera/mime.rb +25 -0
  89. data/lib/aspera/node_simulator.rb +1 -0
  90. data/lib/aspera/oauth/base.rb +35 -25
  91. data/lib/aspera/oauth/factory.rb +1 -0
  92. data/lib/aspera/oauth/generic.rb +1 -1
  93. data/lib/aspera/oauth/jwt.rb +1 -1
  94. data/lib/aspera/oauth/web.rb +9 -8
  95. data/lib/aspera/preview/file_types.rb +4 -4
  96. data/lib/aspera/preview/generator.rb +7 -0
  97. data/lib/aspera/preview/options.rb +4 -4
  98. data/lib/aspera/preview/terminal.rb +4 -3
  99. data/lib/aspera/preview/utils.rb +9 -6
  100. data/lib/aspera/products/connect.rb +1 -1
  101. data/lib/aspera/rainbow.rb +7 -0
  102. data/lib/aspera/rest/aspera_errors.rb +60 -0
  103. data/lib/aspera/rest/call_error.rb +27 -0
  104. data/lib/aspera/rest/client.rb +514 -0
  105. data/lib/aspera/rest/error_analyzer.rb +113 -0
  106. data/lib/aspera/rest/list.rb +143 -0
  107. data/lib/aspera/rest/parameters.rb +55 -0
  108. data/lib/aspera/rest/util.rb +176 -0
  109. data/lib/aspera/rest.rb +7 -621
  110. data/lib/aspera/schema/IBM Aspera Console-enhanced.yaml +1125 -0
  111. data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml +39 -0
  112. data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml +2395 -0
  113. data/lib/aspera/schema/documentation.rb +13 -3
  114. data/lib/aspera/schema/registry.rb +18 -1
  115. data/lib/aspera/schema/validator.rb +92 -0
  116. data/lib/aspera/secret_hider.rb +36 -25
  117. data/lib/aspera/string_ext.rb +15 -0
  118. data/lib/aspera/temp_file_manager.rb +6 -5
  119. data/lib/aspera/transfer/parameters.rb +2 -0
  120. data/lib/aspera/transfer/spec.rb +1 -0
  121. data/lib/aspera/transfer/spec.schema.yaml +1 -0
  122. data/lib/aspera/uri_reader.rb +11 -11
  123. data/lib/aspera/web_auth/index.html +147 -0
  124. data/lib/aspera/web_auth/server.rb +81 -0
  125. data.tar.gz.sig +0 -0
  126. metadata +39 -7
  127. metadata.gz.sig +0 -0
  128. data/lib/aspera/colors.rb +0 -79
  129. data/lib/aspera/rest_call_error.rb +0 -25
  130. data/lib/aspera/rest_error_analyzer.rb +0 -111
  131. data/lib/aspera/rest_errors_aspera.rb +0 -58
  132. data/lib/aspera/rest_list.rb +0 -136
  133. data/lib/aspera/web_auth.rb +0 -211
data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml ADDED
@@ -0,0 +1,2395 @@
1
+ # DO NOT EDIT THIS FILE MANUALLY
2
+ # This file is automatically downloaded from:
3
+ # https://raw.githubusercontent.com/laurent-martin/aspera-api-examples/refs/heads/main/openapi/IBM%20Aspera%20on%20Cloud%20Automation%20API-1.0.5-enhanced.yaml
4
+ # Use 'rake tools:openapi' to update this file
5
+
6
+ openapi: 3.1.0
7
+ info:
8
+ title: Automation API
9
+ description: |-
10
+ The Automation API allows you to create multistep workflows with event-based triggers cued to IBM Aspera on Cloud endpoints. The first step in your workflow contains the trigger, which can be a person or an API, a series of scheduled times, a new file added to a folder, or a package arriving in a shared inbox, or the deletion of a file or folder.
11
+
12
+ The rest of the steps in the workflow contain one or more actions. An action can transfer a file, send a package, call an API, notify users, create custom substitution variables, or create a folder. After you activate the workflow, you can monitor active jobs and update the state of the workflow, which allows you to make edits. Note: Each workflow must contain at least one action that transfers a file or sends a package.
13
+
14
+ Access Control: You must include a JSON Web Token (bearer token) in the authorization header of your request.
15
+
16
+ For additional information, visit the Aspera Developer Center at https://developer.ibm.com/aspera/
17
+ version: 1.0.5
18
+ license:
19
+ url: https://ibm.com
20
+ name: (c) IBM. All rights reserved
21
+ servers:
22
+ - url: https://api.ibmaspera.com/automation/v1
23
+ description: The Automation App production server
24
+ security:
25
+ - bearerAuth: []
26
+ tags:
27
+ - name: workflows
28
+ description: Workflows
29
+ - name: workflow_instances
30
+ description: Jobs (workflow instances)
31
+ - name: steps
32
+ description: Steps of a workflow
33
+ - name: actions
34
+ description: Actions within a step
35
+ - name: workflow_permissions
36
+ description: Permissions on workflows
37
+ paths:
38
+ /workflows:
39
+ get:
40
+ operationId: listWorkflows
41
+ summary: Get workflows
42
+ description: Returns all workflows.
43
+ responses:
44
+ '200':
45
+ description: OK - Successful response
46
+ content:
47
+ application/json:
48
+ schema:
49
+ $ref: '#/components/schemas/200-Workflows'
50
+ '403':
51
+ description: Forbidden. The bearer token is missing or incorrect.
52
+ '500':
53
+ description: Internal Server Error
54
+ tags:
55
+ - workflows
56
+ parameters:
57
+ - $ref: '#/components/parameters/offset'
58
+ - $ref: '#/components/parameters/limit'
59
+ post:
60
+ operationId: createWorkflow
61
+ summary: Create a workflow
62
+ description: Creates a new workflow. Once you have created the workflow, you can create one or more steps within the workflow.
63
+ requestBody:
64
+ required: true
65
+ content:
66
+ application/json:
67
+ schema:
68
+ $ref: '#/components/schemas/createWorkflowRequest'
69
+ responses:
70
+ '201':
71
+ description: Successfully created
72
+ content:
73
+ application/json:
74
+ schema:
75
+ $ref: '#/components/schemas/201-Workflow'
76
+ '400':
77
+ description: Bad Request. The payload may not be in the correct format (JSON format).
78
+ '403':
79
+ description: Forbidden. The bearer token is missing or incorrect.
80
+ '422':
81
+ description: Unprocessable Entity. Incorrect parameter information in payload.
82
+ tags:
83
+ - workflows
84
+ /workflows/{id}:
85
+ get:
86
+ operationId: getWorkflow
87
+ summary: Gets a workflow
88
+ description: Returns a workflow with a unique ID.
89
+ parameters:
90
+ - name: id
91
+ in: path
92
+ description: Numeric ID of the workflow to get
93
+ required: true
94
+ schema:
95
+ type: string
96
+ - name: workflow_version_id
97
+ in: query
98
+ description: Numeric ID of the workflow version to get
99
+ required: false
100
+ schema:
101
+ type: string
102
+ responses:
103
+ '200':
104
+ description: OK - Successful response
105
+ content:
106
+ application/json:
107
+ schema:
108
+ $ref: '#/components/schemas/workflowData'
109
+ '403':
110
+ description: Forbidden. The bearer token is missing or incorrect.
111
+ '500':
112
+ description: Internal Server Error
113
+ tags:
114
+ - workflows
115
+ put:
116
+ operationId: updateWorkflow
117
+ summary: Update a workflow
118
+ description: Allows user to edit a workflow with a unique ID.
119
+ parameters:
120
+ - name: id
121
+ in: path
122
+ description: Numeric ID of the workflow to update
123
+ required: true
124
+ schema:
125
+ type: string
126
+ requestBody:
127
+ required: true
128
+ content:
129
+ application/json:
130
+ schema:
131
+ $ref: '#/components/schemas/updateWorkflow'
132
+ responses:
133
+ '204':
134
+ description: No Content
135
+ '400':
136
+ description: Bad Request. The payload may not be in the correct format (JSON format).
137
+ '403':
138
+ description: Forbidden. The bearer token is missing or incorrect.
139
+ '422':
140
+ description: Unprocessable Entity. Incorrect parameter information in payload.
141
+ tags:
142
+ - workflows
143
+ delete:
144
+ operationId: deleteWorkflow
145
+ summary: Delete a workflow
146
+ description: Allows user to delete a workflow with a unique ID.
147
+ parameters:
148
+ - name: id
149
+ in: path
150
+ description: Numeric ID of the workflow to delete
151
+ required: true
152
+ schema:
153
+ type: string
154
+ responses:
155
+ '204':
156
+ description: No Content
157
+ '403':
158
+ description: Forbidden. The bearer token is missing or incorrect.
159
+ tags:
160
+ - workflows
161
+ /workflows/{id}/update_state:
162
+ put:
163
+ operationId: updateWorkflowState
164
+ summary: Update the workflow state
165
+ description: Updates the state of a workflow with a unique ID.
166
+ parameters:
167
+ - name: id
168
+ in: path
169
+ description: Numeric ID of the workflow to edit
170
+ required: true
171
+ schema:
172
+ type: string
173
+ requestBody:
174
+ required: true
175
+ content:
176
+ application/json:
177
+ schema:
178
+ $ref: '#/components/schemas/updateState'
179
+ example:
180
+ event: activate
181
+ responses:
182
+ '204':
183
+ description: No Content
184
+ '400':
185
+ description: Bad Request. The payload may not be in the correct format (JSON format).
186
+ '403':
187
+ description: Forbidden. The bearer token is missing or incorrect.
188
+ '422':
189
+ description: Unprocessable Entity. Incorrect parameter information in payload.
190
+ tags:
191
+ - workflows
192
+ /workflows/{id}/launch:
193
+ post:
194
+ operationId: launchWorkflow
195
+ summary: Launch a workflow
196
+ description: For a workflow with a manual trigger, launches (activates) a workflow.
197
+ parameters:
198
+ - name: id
199
+ in: path
200
+ description: ID of the workflow that you intend to launch
201
+ required: true
202
+ schema:
203
+ type: string
204
+ example: '2116'
205
+ responses:
206
+ '204':
207
+ description: No Content
208
+ '400':
209
+ description: Bad Request. The payload may not be in the correct format (JSON format).
210
+ '403':
211
+ description: Forbidden. The bearer token is missing or incorrect.
212
+ tags:
213
+ - workflows
214
+ /workflows/{id}/cancel_instances:
215
+ put:
216
+ operationId: cancelWorkflowInstances
217
+ summary: Cancel all jobs
218
+ description: Cancels all running jobs of an active workflow with a particular ID.
219
+ parameters:
220
+ - name: id
221
+ in: path
222
+ description: ID of the workflow for which you are cancelling all running jobs
223
+ required: true
224
+ schema:
225
+ type: string
226
+ example: '1120'
227
+ responses:
228
+ '204':
229
+ description: No Content
230
+ '400':
231
+ description: Bad Request. The payload may not be in the correct format (JSON format).
232
+ '403':
233
+ description: Forbidden. The bearer token is missing or incorrect.
234
+ '404':
235
+ description: Not Found. The workflow ID submitted in the request is incorrect.
236
+ content:
237
+ application/json:
238
+ schema:
239
+ $ref: '#/components/schemas/404-Workflows'
240
+ tags:
241
+ - workflows
242
+ /workflows/{id}/delete_instances:
243
+ delete:
244
+ operationId: deleteWorkflowInstances
245
+ summary: Delete all jobs
246
+ description: Deletes all jobs for an active workflow with a particular ID.
247
+ parameters:
248
+ - name: id
249
+ in: path
250
+ description: ID of the workflow for which you are deleting all jobs
251
+ required: true
252
+ schema:
253
+ type: string
254
+ example: '1120'
255
+ responses:
256
+ '204':
257
+ description: No Content
258
+ '400':
259
+ description: Bad Request. The payload may not be in the correct format (JSON format).
260
+ '403':
261
+ description: Forbidden. The bearer token is missing or incorrect.
262
+ '404':
263
+ description: Not Found. The workflow ID submitted in the request is incorrect.
264
+ content:
265
+ application/json:
266
+ schema:
267
+ $ref: '#/components/schemas/404-Workflows'
268
+ tags:
269
+ - workflows
270
+ /workflow_instances:
271
+ get:
272
+ operationId: listWorkflowInstances
273
+ summary: Get jobs
274
+ description: Returns all jobs of active workflows - whether running, complete, or failed. If you add query parameters (for a particular workflow ID or status), returns a filtered subset of jobs associated with that workflow or status.
275
+ parameters:
276
+ - $ref: '#/components/parameters/workflowID'
277
+ - $ref: '#/components/parameters/status'
278
+ - $ref: '#/components/parameters/offset'
279
+ - $ref: '#/components/parameters/limit'
280
+ responses:
281
+ '200':
282
+ description: OK - Successful response
283
+ content:
284
+ application/json:
285
+ schema:
286
+ $ref: '#/components/schemas/200-WorkflowInstances'
287
+ '403':
288
+ description: Forbidden. The bearer token is missing or incorrect.
289
+ '500':
290
+ description: Internal Server Error
291
+ tags:
292
+ - workflow_instances
293
+ /workflow_instances/{id}:
294
+ get:
295
+ operationId: getWorkflowInstance
296
+ summary: Get a job
297
+ description: Returns a job with a unique ID.
298
+ parameters:
299
+ - name: id
300
+ in: path
301
+ description: Numeric ID of the job to get
302
+ required: true
303
+ schema:
304
+ type: string
305
+ examples:
306
+ - '8588'
307
+ responses:
308
+ '200':
309
+ description: OK - Successful response
310
+ content:
311
+ application/json:
312
+ schema:
313
+ $ref: '#/components/schemas/WorkflowInstances'
314
+ '403':
315
+ description: Forbidden. The bearer token is missing or incorrect.
316
+ '500':
317
+ description: Internal Server Error
318
+ tags:
319
+ - workflow_instances
320
+ delete:
321
+ operationId: deleteWorkflowInstance
322
+ summary: Delete a job
323
+ description: Allows user to delete a job with a unique ID.
324
+ parameters:
325
+ - name: id
326
+ in: path
327
+ description: Numeric ID of the job to delete
328
+ required: true
329
+ schema:
330
+ type: string
331
+ responses:
332
+ '204':
333
+ description: No Content
334
+ '403':
335
+ description: Forbidden. The bearer token is missing or incorrect.
336
+ tags:
337
+ - workflow_instances
338
+ put:
339
+ operationId: cancelWorkflowInstance
340
+ summary: Cancel a job
341
+ description: Cancels a running job with a unique ID. Doing so allows you to edit the workflow that generated the job.
342
+ parameters:
343
+ - name: id
344
+ in: path
345
+ description: Numeric ID of the job to cancel
346
+ required: true
347
+ schema:
348
+ type: string
349
+ requestBody:
350
+ required: true
351
+ content:
352
+ application/json:
353
+ schema:
354
+ $ref: '#/components/schemas/cancelWorkflowInstance'
355
+ responses:
356
+ '204':
357
+ description: No Content
358
+ '403':
359
+ description: Forbidden. The bearer token is missing or incorrect.
360
+ tags:
361
+ - workflow_instances
362
+ /steps:
363
+ post:
364
+ operationId: createStep
365
+ summary: Create a step
366
+ description: Creates a step in the workflow. Each step can hold one or more actions, which you create with POST /actions after creating the step. Steps can be re-ordered within the workflow after they are created, using a PUT /steps/{id} request.
367
+ requestBody:
368
+ required: true
369
+ content:
370
+ application/json:
371
+ schema:
372
+ $ref: '#/components/schemas/Step'
373
+ responses:
374
+ '201':
375
+ description: Successfully created
376
+ content:
377
+ application/json:
378
+ schema:
379
+ $ref: '#/components/schemas/201-Step'
380
+ '400':
381
+ description: Bad Request. The payload may not be in the correct format (JSON format).
382
+ '403':
383
+ description: Forbidden. The bearer token is missing or incorrect.
384
+ '422':
385
+ description: Unprocessable Entity. Incorrect parameter information in payload.
386
+ tags:
387
+ - steps
388
+ /steps/{id}:
389
+ get:
390
+ operationId: getStep
391
+ summary: Get a step
392
+ description: Returns the data for a step with a unique ID, such as the actions associated with that step.
393
+ parameters:
394
+ - name: id
395
+ in: path
396
+ description: Numeric ID of the step to get
397
+ required: true
398
+ schema:
399
+ type: string
400
+ examples:
401
+ - '1076'
402
+ responses:
403
+ '200':
404
+ description: OK - Successful response
405
+ content:
406
+ application/json:
407
+ schema:
408
+ $ref: '#/components/schemas/200-StepsID'
409
+ '403':
410
+ description: Forbidden. The bearer token is missing or incorrect.
411
+ '500':
412
+ description: Internal Server Error
413
+ tags:
414
+ - steps
415
+ put:
416
+ operationId: updateStep
417
+ summary: Update a step
418
+ description: Allows user to edit the details of a step with a unique ID.
419
+ parameters:
420
+ - name: id
421
+ in: path
422
+ description: Numeric ID of the step to update
423
+ required: true
424
+ schema:
425
+ type: string
426
+ requestBody:
427
+ required: true
428
+ content:
429
+ application/json:
430
+ schema:
431
+ $ref: '#/components/schemas/createStepRequest'
432
+ responses:
433
+ '204':
434
+ description: No Content
435
+ '400':
436
+ description: Bad Request. The payload may not be in the correct format (JSON format).
437
+ '403':
438
+ description: Forbidden. The bearer token is missing or incorrect.
439
+ '422':
440
+ description: Unprocessable Entity. Incorrect parameter information in payload.
441
+ tags:
442
+ - steps
443
+ delete:
444
+ operationId: deleteStep
445
+ summary: Delete a step
446
+ description: Allows user to delete a step with a unique ID.
447
+ parameters:
448
+ - name: id
449
+ in: path
450
+ description: Numeric ID of the step to delete
451
+ required: true
452
+ schema:
453
+ type: string
454
+ responses:
455
+ '204':
456
+ description: No Content
457
+ '403':
458
+ description: Forbidden. The bearer token is missing or incorrect.
459
+ tags:
460
+ - steps
461
+ /actions:
462
+ post:
463
+ operationId: createAction
464
+ summary: Create an action
465
+ description: Creates an action that can be used in one or more workflows. Actions can transfer to a node or workspace, send a package, call an API, or notify users. An action is contained in a step; a step can contain multiple actions. Request bodies for transfer and API actions are defined below. For examples of the other action types, go to https://developer.ibm.com/aspera/docs/automation-api-guide/automation-api-action-examples/.
466
+ requestBody:
467
+ required: true
468
+ content:
469
+ application/json:
470
+ schema:
471
+ oneOf:
472
+ - $ref: '#/components/schemas/createActionTransfer'
473
+ - $ref: '#/components/schemas/createActionAPI'
474
+ responses:
475
+ '201':
476
+ description: Successfully created
477
+ content:
478
+ application/json:
479
+ schema:
480
+ oneOf:
481
+ - $ref: '#/components/schemas/201-ActionTransfer'
482
+ - $ref: '#/components/schemas/201-ActionAPI'
483
+ '400':
484
+ description: Bad Request. The payload may not be in the correct format (JSON format).
485
+ '403':
486
+ description: Forbidden. The bearer token is missing or incorrect.
487
+ '422':
488
+ description: Unprocessable Entity. Incorrect parameter information in payload.
489
+ tags:
490
+ - actions
491
+ /actions/{id}:
492
+ get:
493
+ operationId: getAction
494
+ summary: Get an action
495
+ description: Returns data for an action with a unique ID.
496
+ parameters:
497
+ - name: id
498
+ in: path
499
+ description: Numeric ID of the action to get
500
+ required: true
501
+ schema:
502
+ type: string
503
+ examples:
504
+ - '1076'
505
+ responses:
506
+ '200':
507
+ description: OK - Successful response
508
+ content:
509
+ application/json:
510
+ schema:
511
+ $ref: '#/components/schemas/actionData'
512
+ '403':
513
+ description: Forbidden. The bearer token is missing or incorrect.
514
+ '500':
515
+ description: Internal Server Error
516
+ tags:
517
+ - actions
518
+ put:
519
+ operationId: updateAction
520
+ summary: Update an action
521
+ description: Allows user to edit the values of an action with a unique ID.
522
+ parameters:
523
+ - name: id
524
+ in: path
525
+ description: Numeric ID of the action to update
526
+ required: true
527
+ schema:
528
+ type: string
529
+ requestBody:
530
+ required: true
531
+ content:
532
+ application/json:
533
+ schema:
534
+ oneOf:
535
+ - $ref: '#/components/schemas/createActionTransfer'
536
+ - $ref: '#/components/schemas/createActionAPI'
537
+ responses:
538
+ '204':
539
+ description: No Content
540
+ '400':
541
+ description: Bad Request. The payload may not be in the correct format (JSON format).
542
+ '403':
543
+ description: Forbidden. The bearer token is missing or incorrect.
544
+ '422':
545
+ description: Unprocessable Entity. Incorrect parameter information in payload.
546
+ tags:
547
+ - actions
548
+ delete:
549
+ operationId: deleteAction
550
+ summary: Delete an action
551
+ description: Allows user to delete an action with a unique ID.
552
+ parameters:
553
+ - name: id
554
+ in: path
555
+ description: Numeric ID of the action to delete
556
+ required: true
557
+ schema:
558
+ type: string
559
+ responses:
560
+ '204':
561
+ description: No Content
562
+ '403':
563
+ description: Forbidden. The bearer token is missing or incorrect.
564
+ tags:
565
+ - actions
566
+ /workflow_permissions:
567
+ get:
568
+ operationId: listWorkflowPermissions
569
+ summary: Get workflow permissions
570
+ description: Returns all workflow permissions.
571
+ parameters:
572
+ - $ref: '#/components/parameters/workflow_ID'
573
+ responses:
574
+ '200':
575
+ description: OK - Successful response
576
+ content:
577
+ application/json:
578
+ schema:
579
+ $ref: '#/components/schemas/200-WorkflowPermissions'
580
+ '403':
581
+ description: Forbidden. The bearer token is missing or incorrect.
582
+ '500':
583
+ description: Internal Server Error
584
+ tags:
585
+ - workflow_permissions
586
+ post:
587
+ operationId: createWorkflowPermission
588
+ summary: Create a workflow permission
589
+ description: Creates a new permission for a workflow.
590
+ requestBody:
591
+ required: true
592
+ content:
593
+ application/json:
594
+ schema:
595
+ $ref: '#/components/schemas/createWorkflowPermissionRequest'
596
+ responses:
597
+ '201':
598
+ description: Successfully created
599
+ content:
600
+ application/json:
601
+ schema:
602
+ $ref: '#/components/schemas/WorkflowPermissions'
603
+ '400':
604
+ description: Bad Request. The payload may not be in the correct format (JSON format).
605
+ '403':
606
+ description: Forbidden. The bearer token is missing or incorrect.
607
+ '422':
608
+ description: Unprocessable Entity. Incorrect parameter information in payload.
609
+ tags:
610
+ - workflow_permissions
611
+ /workflow_permissions/{id}:
612
+ put:
613
+ operationId: updateWorkflowPermission
614
+ summary: Update a workflow permission
615
+ description: Allows the user to edit a workflow permission with a unique ID.
616
+ parameters:
617
+ - name: id
618
+ in: path
619
+ description: Numeric ID of the workflow permission
620
+ required: true
621
+ schema:
622
+ type: string
623
+ requestBody:
624
+ required: true
625
+ content:
626
+ application/json:
627
+ schema:
628
+ $ref: '#/components/schemas/updateWorkflowPermissionRequest'
629
+ responses:
630
+ '204':
631
+ description: No Content
632
+ '400':
633
+ description: Bad Request. The payload may not be in the correct format (JSON format).
634
+ '403':
635
+ description: Forbidden. The bearer token is missing or incorrect.
636
+ '422':
637
+ description: Unprocessable Entity. Incorrect parameter information in payload.
638
+ tags:
639
+ - workflow_permissions
640
+ delete:
641
+ operationId: deleteWorkflowPermission
642
+ summary: Delete a workflow permission
643
+ description: Allows user to delete a workflow permission with a unique ID.
644
+ parameters:
645
+ - name: id
646
+ in: path
647
+ description: Numeric ID of the workflow permission to delete
648
+ required: true
649
+ schema:
650
+ type: string
651
+ responses:
652
+ '204':
653
+ description: No Content
654
+ '403':
655
+ description: Forbidden. The bearer token is missing or incorrect.
656
+ tags:
657
+ - workflow_permissions
658
+ components:
659
+ parameters:
660
+ status:
661
+ name: status
662
+ in: query
663
+ description: 'Status of the job. Allowed values: executing, failed, complete, canceled.'
664
+ required: false
665
+ schema:
666
+ type: string
667
+ enum:
668
+ - executing
669
+ - failed
670
+ - complete
671
+ - canceled
672
+ example: executing
673
+ workflow_ID:
674
+ name: workflow_id
675
+ in: query
676
+ description: ID of the workflow
677
+ required: true
678
+ schema:
679
+ type: string
680
+ example: '362'
681
+ workflowID:
682
+ name: workflow_id
683
+ in: query
684
+ description: ID of the workflow
685
+ required: false
686
+ schema:
687
+ type: string
688
+ example: '362'
689
+ offset:
690
+ name: offset
691
+ in: query
692
+ description: Offset of the first result to return (pagination)
693
+ required: false
694
+ schema:
695
+ type: integer
696
+ minimum: 0
697
+ default: 0
698
+ limit:
699
+ name: limit
700
+ in: query
701
+ description: Maximum number of results to return
702
+ required: false
703
+ schema:
704
+ type: integer
705
+ minimum: 1
706
+ examples:
707
+ - 20
708
+ schemas:
709
+ 200-WorkflowInstances:
710
+ description: Returned data for all jobs
711
+ type: object
712
+ properties:
713
+ offset:
714
+ description: Controls pagination of the response, in coordination with the limit parameter. If offset = 0 and limit = 20, returns results 1-20 (first page of results). If offset = 1 and limit = 20, returns results 21-40 (second page of results)
715
+ type: integer
716
+ examples:
717
+ - 0
718
+ default: 0
719
+ limit:
720
+ description: Maximum number of workflows for which to return data
721
+ type: integer
722
+ examples:
723
+ - 20
724
+ first:
725
+ description: The link for the first page of results
726
+ type: object
727
+ properties:
728
+ href:
729
+ description: URL for the first page of results
730
+ type: string
731
+ format: uri
732
+ examples:
733
+ - http://api.qa.ibmaspera.com/automation/v1/workflow_instances?limit=20&offset=0
734
+ last:
735
+ description: The link for the last page of results
736
+ type: object
737
+ properties:
738
+ href:
739
+ description: URL for the last page of results
740
+ type: string
741
+ format: uri
742
+ examples:
743
+ - http://api.qa.ibmaspera.com/automation/v1/workflow_instances?limit=20&offset=20
744
+ next:
745
+ description: The link for the second page of results
746
+ type: object
747
+ properties:
748
+ href:
749
+ description: URL for the second page of results
750
+ type: string
751
+ format: uri
752
+ examples:
753
+ - http://api.qa.ibmaspera.com/automation/v1/workflow_instances?limit=20&offset=1
754
+ workflow_instances:
755
+ description: Array of jobs
756
+ type: array
757
+ items:
758
+ $ref: '#/components/schemas/WorkflowInstances'
759
+ title: Success response
760
+ WorkflowInstances:
761
+ description: Job data
762
+ type: object
763
+ properties:
764
+ id:
765
+ description: ID for the workflow instance
766
+ type: string
767
+ examples:
768
+ - '8588'
769
+ workflow_version_id:
770
+ description: ID for the workflow version that is used in generating this workflow instance
771
+ type: string
772
+ examples:
773
+ - '8588'
774
+ instance_id:
775
+ description: UUID. Can be used for debugging purposes.
776
+ type: string
777
+ examples:
778
+ - f5d74b9c-e2de-4782-9a44-e65b4857d98b
779
+ organization_id:
780
+ description: ID of organization from which the workflow originates
781
+ type: string
782
+ examples:
783
+ - '58'
784
+ user_id:
785
+ description: User ID of user initiating the workflow instance
786
+ type: string
787
+ examples:
788
+ - '3201'
789
+ workflow_id:
790
+ description: ID of the workflow that generates the workflow instance
791
+ type: string
792
+ examples:
793
+ - '699'
794
+ step_id:
795
+ description: ID of step in the workflow that generates the workflow instance
796
+ type: string
797
+ examples:
798
+ - '1290'
799
+ step_name:
800
+ description: Name of step in the workflow that is currently active. If the workflow is complete or failed, step_name is the name of the final step in the workflow.
801
+ type: string
802
+ examples:
803
+ - transfer step
804
+ status:
805
+ description: 'Status of the workflow instance. Allowed values: executing, failed, complete, canceled.'
806
+ type: string
807
+ examples:
808
+ - complete
809
+ enum:
810
+ - executing
811
+ - failed
812
+ - complete
813
+ - canceled
814
+ status_details:
815
+ description: Error message - only returned for a failed workflow instance
816
+ type: string
817
+ examples:
818
+ - No valid permission on the source node available
819
+ launch_time:
820
+ description: Original start time for activation of the workflow
821
+ type: string
822
+ format: date-time
823
+ examples:
824
+ - 2019-03-17T07:07:15.000Z
825
+ state_change_time:
826
+ description: Time the workflow instance state was changed--for example, with a PUT request.
827
+ type: string
828
+ format: date-time
829
+ examples:
830
+ - 2019-03-17T07:07:22.000Z
831
+ workflow_name:
832
+ description: Name of the workflow
833
+ type: string
834
+ examples:
835
+ - media content
836
+ 200-WorkflowPermissions:
837
+ description: Returned data for all workflow permissions
838
+ type: object
839
+ properties:
840
+ workflow_permissions:
841
+ description: Array of workflow permissions
842
+ type: array
843
+ items:
844
+ $ref: '#/components/schemas/WorkflowPermissions'
845
+ title: Success response
846
+ WorkflowPermissions:
847
+ type: object
848
+ properties:
849
+ id:
850
+ description: Workflow Permission ID
851
+ type: string
852
+ examples:
853
+ - '26'
854
+ user_id:
855
+ description: User ID
856
+ type: string
857
+ examples:
858
+ - '26'
859
+ workflow_id:
860
+ description: Workflow ID
861
+ type: string
862
+ examples:
863
+ - '26'
864
+ manage_jobs:
865
+ description: Whether there is permission to manage jobs
866
+ type: boolean
867
+ examples:
868
+ - true
869
+ duplicate:
870
+ description: Whether there is permission to duplicate workflows
871
+ type: boolean
872
+ examples:
873
+ - true
874
+ updated_at:
875
+ description: Time workflow is updated
876
+ type: string
877
+ format: date-time
878
+ examples:
879
+ - 2019-01-10T21:25:24.000Z
880
+ created_at:
881
+ description: Time workflow permission is created
882
+ type: string
883
+ format: date-time
884
+ examples:
885
+ - 2019-01-10T21:25:24.000Z
886
+ title: Success response
887
+ 200-Workflows:
888
+ type: object
889
+ properties:
890
+ offset:
891
+ description: Controls pagination of the response, in coordination with the limit parameter. If offset = 0 and limit = 20, returns results 1-20 (first page of results). If offset = 1 and limit = 20, returns results 21-40 (second page of results)
892
+ type: integer
893
+ examples:
894
+ - 0
895
+ default: 0
896
+ limit:
897
+ description: Maximum number of workflows for which to return data
898
+ type: integer
899
+ examples:
900
+ - 20
901
+ first:
902
+ description: The link for the first page of results
903
+ type: object
904
+ properties:
905
+ href:
906
+ description: URL for the first page of results
907
+ type: string
908
+ format: uri
909
+ examples:
910
+ - http://api.qa.ibmaspera.com/automation/v1/workflows?limit=20&offset=0
911
+ last:
912
+ description: The link for the last page of results
913
+ type: object
914
+ properties:
915
+ href:
916
+ description: URL for the last page of results
917
+ type: string
918
+ format: uri
919
+ examples:
920
+ - http://api.qa.ibmaspera.com/automation/v1/workflows?limit=20&offset=20
921
+ next:
922
+ description: The link for the second page of results
923
+ type: object
924
+ properties:
925
+ href:
926
+ description: URL for the second page of results
927
+ type: string
928
+ format: uri
929
+ examples:
930
+ - http://api.qa.ibmaspera.com/automation/v1/workflows?limit=20&offset=1
931
+ total_count:
932
+ description: Number of workflows for the current user
933
+ type: integer
934
+ examples:
935
+ - 6
936
+ workflows:
937
+ type: array
938
+ items:
939
+ $ref: '#/components/schemas/workflowData'
940
+ title: Success response
941
+ workflowData:
942
+ description: Returned workflow data
943
+ type: object
944
+ properties:
945
+ id:
946
+ description: Workflow ID
947
+ type: string
948
+ examples:
949
+ - '26'
950
+ name:
951
+ description: Workflow name
952
+ type: string
953
+ examples:
954
+ - test workflow
955
+ organization_id:
956
+ description: ID of organization associated with the workflow
957
+ type: string
958
+ examples:
959
+ - '58'
960
+ user_id:
961
+ description: ID of user who created the workflow
962
+ type: string
963
+ examples:
964
+ - '1072'
965
+ state:
966
+ description: 'State of the workflow. Allowed values: draft, active, inactive, error.'
967
+ type: string
968
+ examples:
969
+ - draft
970
+ enum:
971
+ - draft
972
+ - active
973
+ - inactive
974
+ - error
975
+ status:
976
+ description: 'Workflow status. Allowed values: not_started, executing, failed, complete, canceled.'
977
+ type: string
978
+ examples:
979
+ - not_started
980
+ enum:
981
+ - not_started
982
+ - executing
983
+ - failed
984
+ - complete
985
+ - canceled
986
+ steps:
987
+ description: Array of step data
988
+ type: array
989
+ items:
990
+ $ref: '#/components/schemas/Steps'
991
+ step_order:
992
+ description: Array of step IDs, in the order they appear in the workflow
993
+ type: array
994
+ items:
995
+ type: string
996
+ examples:
997
+ - - '1076'
998
+ - '1077'
999
+ - '1078'
1000
+ workflow_notifications:
1001
+ description: Object containing hashes of recipient data for workflow notifications with a status of started, completed, and failed
1002
+ type: object
1003
+ properties:
1004
+ started:
1005
+ description: Hashes of recipient data for workflow notifications with a status of started
1006
+ type: array
1007
+ items:
1008
+ type: object
1009
+ properties:
1010
+ id:
1011
+ description: ID of user or group, or email of user
1012
+ type: string
1013
+ type:
1014
+ description: Type of recipient
1015
+ type: string
1016
+ enum:
1017
+ - User
1018
+ - Group
1019
+ - Email
1020
+ examples:
1021
+ - - id: example@email.com
1022
+ type: Email
1023
+ failed:
1024
+ description: Hashes of recipient data for workflow notifications with a status of failed
1025
+ type: array
1026
+ items:
1027
+ type: object
1028
+ properties:
1029
+ id:
1030
+ description: ID of user or group, or email of user
1031
+ type: string
1032
+ type:
1033
+ description: Type of recipient
1034
+ type: string
1035
+ enum:
1036
+ - User
1037
+ - Group
1038
+ - Email
1039
+ examples:
1040
+ - - id: example@email.com
1041
+ type: Email
1042
+ completed:
1043
+ description: Hashes of recipient data for workflow notifications with a status of completed
1044
+ type: array
1045
+ items:
1046
+ type: object
1047
+ properties:
1048
+ id:
1049
+ description: ID of user or group, or email of user
1050
+ type: string
1051
+ type:
1052
+ description: Type of recipient
1053
+ type: string
1054
+ enum:
1055
+ - User
1056
+ - Group
1057
+ - Email
1058
+ examples:
1059
+ - - id: example@email.com
1060
+ type: Email
1061
+ updated_at:
1062
+ description: Time workflow is updated
1063
+ type: string
1064
+ format: date-time
1065
+ examples:
1066
+ - 2019-01-10T21:25:24.000Z
1067
+ trigger_type:
1068
+ description: 'Trigger type for the workflow. Allowed values: manual, shared_inbox, watch_folder, scheduled.'
1069
+ type: string
1070
+ examples:
1071
+ - scheduled
1072
+ enum:
1073
+ - manual
1074
+ - shared_inbox
1075
+ - watch_folder
1076
+ - scheduled
1077
+ workflow_can_activate:
1078
+ description: The workflow has a transfer step or send package step. This is a mandatory condition.
1079
+ type: boolean
1080
+ examples:
1081
+ - false
1082
+ instance_stats:
1083
+ $ref: '#/components/schemas/InstanceStats'
1084
+ description: Shows the running/completed/failed stats for the workflow
1085
+ InstanceStats:
1086
+ description: Shows runtime statistics of a workflow
1087
+ type: object
1088
+ properties:
1089
+ running:
1090
+ description: Number of running instances
1091
+ type: string
1092
+ examples:
1093
+ - '10'
1094
+ failed:
1095
+ description: Number of failed instances
1096
+ type: string
1097
+ examples:
1098
+ - '10'
1099
+ completed:
1100
+ description: Number of completed instances
1101
+ type: string
1102
+ examples:
1103
+ - '10'
1104
+ Steps:
1105
+ description: Object that contains step data
1106
+ type: object
1107
+ properties:
1108
+ id:
1109
+ description: Step ID
1110
+ type: string
1111
+ examples:
1112
+ - '1260'
1113
+ name:
1114
+ description: Name you assign to the step
1115
+ type: string
1116
+ examples:
1117
+ - transcode step
1118
+ action_order:
1119
+ description: Order of actions in a step, listed by action ID
1120
+ type: array
1121
+ items:
1122
+ type: string
1123
+ examples:
1124
+ - - '1272'
1125
+ - '1263'
1126
+ 201-Workflow:
1127
+ type: object
1128
+ properties:
1129
+ id:
1130
+ description: Workflow ID
1131
+ type: string
1132
+ examples:
1133
+ - '560'
1134
+ name:
1135
+ description: Workflow name
1136
+ type: string
1137
+ examples:
1138
+ - Send Files to CBS
1139
+ organization_id:
1140
+ description: Organization ID
1141
+ type: string
1142
+ examples:
1143
+ - '7301'
1144
+ user_id:
1145
+ description: User ID
1146
+ type: string
1147
+ examples:
1148
+ - '1230'
1149
+ state:
1150
+ description: 'The state of the workflow. Allowed values: draft, active, inactive, error.'
1151
+ type: string
1152
+ examples:
1153
+ - draft
1154
+ enum:
1155
+ - draft
1156
+ - active
1157
+ - inactive
1158
+ - error
1159
+ status:
1160
+ description: 'Workflow status. Allowed values: not_started, executing, failed, complete, canceled.'
1161
+ type: string
1162
+ examples:
1163
+ - not_started
1164
+ enum:
1165
+ - not_started
1166
+ - executing
1167
+ - failed
1168
+ - complete
1169
+ - canceled
1170
+ steps:
1171
+ description: Array of step data
1172
+ type: array
1173
+ items:
1174
+ $ref: '#/components/schemas/Steps'
1175
+ step_order:
1176
+ description: Array of step IDs, in the order they appear in the workflow
1177
+ type: array
1178
+ items:
1179
+ type: string
1180
+ examples:
1181
+ - - '1076'
1182
+ - '1077'
1183
+ - '1078'
1184
+ updated_at:
1185
+ description: Time workflow is updated
1186
+ type: string
1187
+ format: date-time
1188
+ examples:
1189
+ - 2019-02-19T23:52:20.000Z
1190
+ trigger_type:
1191
+ description: 'Trigger type for the workflow. Allowed values: manual, shared_inbox, watch_folder, scheduled.'
1192
+ type: string
1193
+ examples:
1194
+ - manual
1195
+ enum:
1196
+ - manual
1197
+ - shared_inbox
1198
+ - watch_folder
1199
+ - scheduled
1200
+ workflow_can_activate:
1201
+ description: The workflow has a transfer step or send package step. This is a mandatory condition.
1202
+ type: boolean
1203
+ examples:
1204
+ - false
1205
+ title: Success response
1206
+ 404-Workflows:
1207
+ description: The workflow ID submitted in the request is incorrect.
1208
+ type: object
1209
+ properties:
1210
+ message:
1211
+ description: The error message in the response
1212
+ type: string
1213
+ examples:
1214
+ - Couldn't find workflow with 'id'=42343242
1215
+ title: Error response
1216
+ 200-StepsID:
1217
+ description: Returned data for a step with a unique ID.
1218
+ type: object
1219
+ properties:
1220
+ id:
1221
+ description: ID of the step
1222
+ type: string
1223
+ examples:
1224
+ - '1076'
1225
+ name:
1226
+ description: Name of the step. Null if no name is assigned.
1227
+ type:
1228
+ - string
1229
+ - 'null'
1230
+ examples:
1231
+ - notification to admins
1232
+ action_order:
1233
+ description: Order of actions in a step, listed by action ID
1234
+ type: array
1235
+ items:
1236
+ type: string
1237
+ examples:
1238
+ - - '1273'
1239
+ - '1262'
1240
+ - '1274'
1241
+ actions:
1242
+ description: Data for actions in the step
1243
+ type: array
1244
+ items:
1245
+ $ref: '#/components/schemas/actionData'
1246
+ title: Success response
1247
+ actionData:
1248
+ type: object
1249
+ properties:
1250
+ id:
1251
+ description: ID of the action
1252
+ type: string
1253
+ examples:
1254
+ - '1071'
1255
+ name:
1256
+ description: Name of the action. Null if no name is assigned.
1257
+ type:
1258
+ - string
1259
+ - 'null'
1260
+ examples:
1261
+ - null
1262
+ type:
1263
+ description: 'Type of action, which can include a workflow trigger. Allowed values: transfer, send_package, api, email_notification, manual, shared_inbox, watch_folder, scheduled.'
1264
+ type: string
1265
+ examples:
1266
+ - scheduled
1267
+ enum:
1268
+ - transfer
1269
+ - send_package
1270
+ - api
1271
+ - email_notification
1272
+ - manual
1273
+ - shared_inbox
1274
+ - watch_folder
1275
+ - scheduled
1276
+ data:
1277
+ description: Detailed action data
1278
+ type: object
1279
+ properties:
1280
+ start_date:
1281
+ description: Date and time when the scheduled trigger is initiated
1282
+ type: string
1283
+ format: date-time
1284
+ examples:
1285
+ - 2019-03-13T05:32:28.784Z
1286
+ substitutions:
1287
+ description: Data for substitution variables included in the message
1288
+ type: array
1289
+ items:
1290
+ $ref: '#/components/schemas/substitutionVariables'
1291
+ repeat_interval:
1292
+ description: Details about the workflow trigger (action) of type 'scheduled'
1293
+ type: object
1294
+ properties:
1295
+ repeat_type:
1296
+ description: Unit of time for the scheduled trigger
1297
+ type: string
1298
+ examples:
1299
+ - minutes
1300
+ repeat_number:
1301
+ description: Number of times to trigger the workflow
1302
+ type: integer
1303
+ examples:
1304
+ - 20
1305
+ days_of_the_week:
1306
+ description: Days on which to trigger the workflow, if applicable
1307
+ type: array
1308
+ items:
1309
+ type: string
1310
+ examples:
1311
+ - []
1312
+ outputs:
1313
+ description: Describes the format of action outputs that can be added as substitution variables in subsequent actions.
1314
+ type: object
1315
+ properties:
1316
+ timestamp:
1317
+ description: Transfer timestamp output
1318
+ type: string
1319
+ examples:
1320
+ - iso8601
1321
+ 201-Step:
1322
+ type: object
1323
+ properties:
1324
+ id:
1325
+ description: ID of the new step
1326
+ type: string
1327
+ examples:
1328
+ - '1454'
1329
+ name:
1330
+ description: Name of the step. Null if not declared in the request.
1331
+ type:
1332
+ - string
1333
+ - 'null'
1334
+ examples:
1335
+ - notification step
1336
+ action_order:
1337
+ description: Order of actions in a step, listed by action ID
1338
+ type: array
1339
+ items:
1340
+ type: string
1341
+ examples:
1342
+ - - '1273'
1343
+ - '1262'
1344
+ - '1274'
1345
+ title: Success response
1346
+ substitutionVariables:
1347
+ type: object
1348
+ properties:
1349
+ template:
1350
+ description: Template for insertion of substitution variables in the message
1351
+ type: string
1352
+ examples:
1353
+ - '{{step_id_1357.action_id_1409.node_id}}'
1354
+ path:
1355
+ description: Path to the substitution variable
1356
+ type: array
1357
+ items:
1358
+ $ref: '#/components/schemas/substitutionVariablesPath'
1359
+ substitutionVariablesPath:
1360
+ type: object
1361
+ properties:
1362
+ name:
1363
+ description: Name for the path. Allowed values, source, file_id, node_id, message, value, conditions.
1364
+ type: string
1365
+ examples:
1366
+ - message
1367
+ enum:
1368
+ - source
1369
+ - file_id
1370
+ - node_id
1371
+ - message
1372
+ - value
1373
+ - conditions
1374
+ type:
1375
+ description: 'Path type. Allowed values: map, array. Note that path type of map indicates a key:value pair.'
1376
+ type: string
1377
+ examples:
1378
+ - map
1379
+ enum:
1380
+ - map
1381
+ - array
1382
+ index:
1383
+ description: Index of the substitution variable
1384
+ type: integer
1385
+ examples:
1386
+ - 0
1387
+ 201-ActionAPI:
1388
+ type: object
1389
+ properties:
1390
+ id:
1391
+ description: Action ID
1392
+ type: string
1393
+ examples:
1394
+ - '647'
1395
+ name:
1396
+ description: 'Name assigned to the action. Default: null.'
1397
+ type:
1398
+ - string
1399
+ - 'null'
1400
+ examples:
1401
+ - Get status
1402
+ type:
1403
+ description: The type of action. For an action that calls an API, type is always api.
1404
+ type: string
1405
+ examples:
1406
+ - api
1407
+ data:
1408
+ type: object
1409
+ properties:
1410
+ method:
1411
+ description: 'API method. Allowed values: get, post, put, delete.'
1412
+ type: string
1413
+ examples:
1414
+ - get
1415
+ endpoint:
1416
+ description: Endpoint for the API call
1417
+ type: string
1418
+ format: uri
1419
+ examples:
1420
+ - https://api.asperafiles.com/automation/v1/workflows
1421
+ authentication:
1422
+ description: Authentication for the request.
1423
+ type: object
1424
+ properties:
1425
+ type:
1426
+ description: |-
1427
+ Authentication type required by the API. Allowed values: bearer, basic, none. Default: none. Use 'bearer' for bearer token authentication, for basic authentication, 'none' for no authentication method.
1428
+
1429
+ The bearer authentication type requires a token parameter. Allowed values: none, bearer, basic. Default: none. The basic authentication type requires username and password parameters. The 'none' authentication type does not require additional parameters.
1430
+ type: string
1431
+ examples:
1432
+ - bearer
1433
+ default: none
1434
+ enum:
1435
+ - none
1436
+ - bearer
1437
+ - basic
1438
+ token:
1439
+ description: Bearer token for the bearer authentication type
1440
+ type: string
1441
+ examples:
1442
+ - ''
1443
+ username:
1444
+ description: Username for the basic authentication type
1445
+ type: string
1446
+ examples:
1447
+ - jabrams
1448
+ password:
1449
+ description: Password for the basic authentication type
1450
+ type: string
1451
+ examples:
1452
+ - llk3lk4&W@
1453
+ headers:
1454
+ description: Headers returned in the response
1455
+ type: array
1456
+ items:
1457
+ $ref: '#/components/schemas/Headers'
1458
+ substitutions:
1459
+ description: Data for substitution variables included in the message
1460
+ type: array
1461
+ items:
1462
+ $ref: '#/components/schemas/substitutionVariables'
1463
+ outputs:
1464
+ description: Describes the format of action outputs that can be added as substitution variables in subsequent actions.
1465
+ type: object
1466
+ properties:
1467
+ status:
1468
+ description: Status output
1469
+ type: string
1470
+ examples:
1471
+ - string
1472
+ response_code:
1473
+ description: Response code output
1474
+ type: string
1475
+ examples:
1476
+ - integer
1477
+ response_body:
1478
+ description: Response body output
1479
+ type: string
1480
+ examples:
1481
+ - hash
1482
+ title: Success response
1483
+ 201-ActionTransfer:
1484
+ type: object
1485
+ properties:
1486
+ id:
1487
+ description: Action ID
1488
+ type: string
1489
+ examples:
1490
+ - '647'
1491
+ name:
1492
+ description: Action Name
1493
+ type: string
1494
+ examples:
1495
+ - first transfer
1496
+ type:
1497
+ description: The type of action. For an action that transfers a file, the type is always transfer.
1498
+ type: string
1499
+ examples:
1500
+ - transfer
1501
+ data:
1502
+ description: Data for the action
1503
+ type: object
1504
+ properties:
1505
+ target_rate:
1506
+ type: object
1507
+ properties:
1508
+ rate:
1509
+ description: Transfer rate, in bytes per second
1510
+ type: integer
1511
+ examples:
1512
+ - 10000
1513
+ default: 10000
1514
+ allow_retry:
1515
+ description: Whether to allow retry of a failed transfer
1516
+ type: boolean
1517
+ examples:
1518
+ - true
1519
+ default: true
1520
+ retry_attempts:
1521
+ description: Number of allowed retry attempts for the transfer
1522
+ type: integer
1523
+ examples:
1524
+ - 3
1525
+ default: 3
1526
+ retry_interval:
1527
+ description: Interval, in seconds, after which Automation retries the transfer
1528
+ type: integer
1529
+ examples:
1530
+ - 30
1531
+ default: 30
1532
+ content_encryption:
1533
+ type: object
1534
+ properties:
1535
+ encryption:
1536
+ description: Type of content encryption.
1537
+ type: string
1538
+ examples:
1539
+ - aes-128
1540
+ enum:
1541
+ - aes-128
1542
+ - aes-256
1543
+ - aes-192
1544
+ - none
1545
+ apply_protection:
1546
+ description: Apply protection to the file transfer
1547
+ type: boolean
1548
+ examples:
1549
+ - true
1550
+ password:
1551
+ description: Password for the transfer, used if the value of apply_protection is true.
1552
+ type: string
1553
+ examples:
1554
+ - lHF%SHJrjk
1555
+ resume_policy:
1556
+ type: object
1557
+ properties:
1558
+ resume_partials:
1559
+ description: Resume partial transfers for a paused transfer
1560
+ type: boolean
1561
+ examples:
1562
+ - true
1563
+ difference_check:
1564
+ description: 'Type of check used to validate content. Allowed values: attrs, none.'
1565
+ type: string
1566
+ examples:
1567
+ - attrs
1568
+ enum:
1569
+ - attrs
1570
+ - none
1571
+ destination_file_options:
1572
+ description: 'Processing options for file at destination. Allowed values: overwrite_always, overwrite_both_newer_and_different, overwrite_different, overwrite_newer, overwrite_never.'
1573
+ type: string
1574
+ examples:
1575
+ - overwrite_always
1576
+ enum:
1577
+ - overwrite_always
1578
+ - overwrite_both_newer_and_different
1579
+ - overwrite_different
1580
+ - overwrite_newer
1581
+ - overwrite_never
1582
+ file_attributes:
1583
+ description: File attributes are defined
1584
+ type: boolean
1585
+ examples:
1586
+ - true
1587
+ source_archive:
1588
+ description: Archive policy for the transfer source
1589
+ type: object
1590
+ properties:
1591
+ archive_option:
1592
+ description: 'Archive policy for the package at the source. Allowed values: none, archive, delete.'
1593
+ type: string
1594
+ examples:
1595
+ - archive
1596
+ enum:
1597
+ - none
1598
+ - archive
1599
+ - delete
1600
+ delete_empty_subdirectories:
1601
+ description: Delete empty subdirectories at source after transfer
1602
+ type: boolean
1603
+ examples:
1604
+ - false
1605
+ move_after_transfer:
1606
+ description: Archive location in case of archiving. (location relative to source path)
1607
+ type: string
1608
+ examples:
1609
+ - /abc/def
1610
+ remove_skipped:
1611
+ description: Archive location in case of delete source. to remove the skipped files
1612
+ type: boolean
1613
+ examples:
1614
+ - true
1615
+ conditions_type:
1616
+ description: 'The conditions type for the transfer. Allowed values: all_new (transfers all new files), custom (adds custom filtering conditions). Default: all-new.'
1617
+ type: string
1618
+ examples:
1619
+ - custom
1620
+ default: all_new
1621
+ enum:
1622
+ - custom
1623
+ - all_new
1624
+ join_type:
1625
+ description: 'The logical operator. Allowed values: and, or'
1626
+ type: string
1627
+ examples:
1628
+ - and
1629
+ conditions:
1630
+ description: Filtering conditions for the transfer
1631
+ type: array
1632
+ items:
1633
+ $ref: '#/components/schemas/Conditions'
1634
+ substitutions:
1635
+ description: Data for substitution variables from previous steps, inserted into the message
1636
+ type: array
1637
+ items:
1638
+ $ref: '#/components/schemas/substitutionVariables'
1639
+ source:
1640
+ type: object
1641
+ properties:
1642
+ type:
1643
+ description: 'Source type for transfer. Allowed values: node, workspace.'
1644
+ type: string
1645
+ examples:
1646
+ - node
1647
+ node_id:
1648
+ description: ID of node
1649
+ type: string
1650
+ examples:
1651
+ - '4724'
1652
+ node_name:
1653
+ description: Name of node
1654
+ type: string
1655
+ examples:
1656
+ - Lor_3_node
1657
+ workspace_id:
1658
+ description: ID of workspace
1659
+ type: string
1660
+ examples:
1661
+ - '367'
1662
+ workspace_name:
1663
+ description: Name of workspace
1664
+ type: string
1665
+ examples:
1666
+ - editing_team
1667
+ file_name:
1668
+ description: Filename for file being transferred
1669
+ type: string
1670
+ examples:
1671
+ - 1112_m
1672
+ file_id:
1673
+ description: File ID for file being transferred
1674
+ type: string
1675
+ examples:
1676
+ - '1755550'
1677
+ paths:
1678
+ description: Array of objects that contain source paths for transfer
1679
+ type: array
1680
+ items:
1681
+ $ref: '#/components/schemas/Paths'
1682
+ outputs:
1683
+ description: Describes the format of action outputs that can be added as substitution variables in subsequent actions.
1684
+ type: object
1685
+ properties:
1686
+ status:
1687
+ description: Status output
1688
+ type: string
1689
+ examples:
1690
+ - string
1691
+ transfer_uuid:
1692
+ description: Transfer UUID output
1693
+ type: string
1694
+ examples:
1695
+ - string
1696
+ timestamp:
1697
+ description: Transfer timestamp output
1698
+ type: string
1699
+ examples:
1700
+ - iso8601
1701
+ title: Success response
1702
+ Step:
1703
+ type: object
1704
+ properties:
1705
+ workflow_id:
1706
+ description: ID of workflow that contains the step
1707
+ type: string
1708
+ examples:
1709
+ - '1260'
1710
+ name:
1711
+ description: The name of the step
1712
+ type: string
1713
+ examples:
1714
+ - transfer step
1715
+ action_order:
1716
+ description: Order of actions in a step, listed by action ID
1717
+ type: array
1718
+ items:
1719
+ type: string
1720
+ examples:
1721
+ - - '1273'
1722
+ - '1262'
1723
+ - '1274'
1724
+ required:
1725
+ - workflow_id
1726
+ createWorkflowRequest:
1727
+ type: object
1728
+ properties:
1729
+ name:
1730
+ description: Name of new workflow
1731
+ type: string
1732
+ examples:
1733
+ - Send Files to Media
1734
+ required:
1735
+ - name
1736
+ title: Creates a new workflow
1737
+ createWorkflowPermissionRequest:
1738
+ type: object
1739
+ properties:
1740
+ user_id:
1741
+ description: User ID to associate with the permission
1742
+ type: string
1743
+ examples:
1744
+ - '32'
1745
+ workflow_id:
1746
+ description: ID for the workflow on which to create the permission
1747
+ type: string
1748
+ examples:
1749
+ - '32'
1750
+ duplicate:
1751
+ description: Whether to give permission to duplicate the workflow
1752
+ type: boolean
1753
+ examples:
1754
+ - true
1755
+ manage_jobs:
1756
+ description: Whether to give permission to manage workflow jobs
1757
+ type: boolean
1758
+ examples:
1759
+ - true
1760
+ required:
1761
+ - user_id
1762
+ - workflow_id
1763
+ - duplicate
1764
+ - manage_jobs
1765
+ title: Creates a new workflow permission
1766
+ updateWorkflow:
1767
+ description: Updates name and step order of an existing workflow
1768
+ type: object
1769
+ properties:
1770
+ name:
1771
+ description: Name of new workflow
1772
+ type: string
1773
+ examples:
1774
+ - Send Files to Media
1775
+ step_order:
1776
+ description: Array of workflow steps, in the order they appear in the workflow
1777
+ type: array
1778
+ items:
1779
+ type: string
1780
+ examples:
1781
+ - - '321'
1782
+ - '123'
1783
+ - '111'
1784
+ required:
1785
+ - name
1786
+ - step_order
1787
+ title: Updates an existing workflow
1788
+ cancelWorkflowInstance:
1789
+ type: object
1790
+ properties:
1791
+ status:
1792
+ description: Status of the workflow instance. To cancel a workflow instance, the value is always canceled.
1793
+ type: string
1794
+ examples:
1795
+ - canceled
1796
+ enum:
1797
+ - canceled
1798
+ required:
1799
+ - status
1800
+ title: Cancel a running workflow instance
1801
+ createStepRequest:
1802
+ type: object
1803
+ properties:
1804
+ workflow_id:
1805
+ description: ID of the workflow
1806
+ type: string
1807
+ examples:
1808
+ - '2512'
1809
+ name:
1810
+ description: Name of the step
1811
+ type: string
1812
+ examples:
1813
+ - notification step
1814
+ action_order:
1815
+ description: Order of actions in a step, listed by action ID
1816
+ type: array
1817
+ items:
1818
+ type: string
1819
+ examples:
1820
+ - - '1273'
1821
+ - '1262'
1822
+ - '1274'
1823
+ required:
1824
+ - workflow_id
1825
+ title: Creates a new step
1826
+ createActionAPI:
1827
+ type: object
1828
+ properties:
1829
+ data:
1830
+ description: Payload for the action
1831
+ type: object
1832
+ properties:
1833
+ method:
1834
+ description: 'API method for the request. Allowed values: get, post, put, delete.'
1835
+ type: string
1836
+ examples:
1837
+ - get
1838
+ enum:
1839
+ - get
1840
+ - post
1841
+ - put
1842
+ - delete
1843
+ headers:
1844
+ description: Request headers
1845
+ type: array
1846
+ items:
1847
+ $ref: '#/components/schemas/Headers'
1848
+ authentication:
1849
+ description: Authentication for the request.
1850
+ type: object
1851
+ properties:
1852
+ type:
1853
+ description: |-
1854
+ Authentication type required by the API. Allowed values: bearer, basic, none. Default: none. Use 'bearer' for bearer token authentication, for basic authentication, 'none' for no authentication method.
1855
+
1856
+ Allowed values: none, bearer, basic. Default: none. The basic authentication type requires a username parameter and a password parameter. The bearer authentication type requires a token parameter. The 'none' authentication type does not require additional parameters.
1857
+ type: string
1858
+ examples:
1859
+ - bearer
1860
+ default: none
1861
+ enum:
1862
+ - none
1863
+ - bearer
1864
+ - basic
1865
+ token:
1866
+ description: Bearer token for the bearer authentication type
1867
+ type: string
1868
+ examples:
1869
+ - ''
1870
+ username:
1871
+ description: Username for the basic authentication type
1872
+ type: string
1873
+ examples:
1874
+ - jabrams
1875
+ password:
1876
+ description: Password for the basic authentication type
1877
+ type: string
1878
+ examples:
1879
+ - llk3lk4&W@
1880
+ endpoint:
1881
+ description: Endpoint for the request
1882
+ type: string
1883
+ format: uri
1884
+ examples:
1885
+ - https://www.google.com
1886
+ substitutions:
1887
+ description: Data for substitution variables from previous steps, inserted into the message
1888
+ type: array
1889
+ items:
1890
+ $ref: '#/components/schemas/substitutionVariables'
1891
+ required:
1892
+ - method
1893
+ - endpoint
1894
+ type:
1895
+ description: Action type. For an action that calls an API, the type is always api.
1896
+ type: string
1897
+ examples:
1898
+ - api
1899
+ enum:
1900
+ - api
1901
+ step_id:
1902
+ description: ID of step that contains the action
1903
+ type: string
1904
+ examples:
1905
+ - '1406'
1906
+ required:
1907
+ - data
1908
+ - type
1909
+ - step_id
1910
+ title: Creates a new action that calls an API
1911
+ Headers:
1912
+ type: object
1913
+ properties:
1914
+ key:
1915
+ description: Header key
1916
+ type: string
1917
+ examples:
1918
+ - Content-Type
1919
+ value:
1920
+ description: Header value
1921
+ type: string
1922
+ examples:
1923
+ - text/html
1924
+ required:
1925
+ - key
1926
+ - value
1927
+ createActionTransfer:
1928
+ description: The node_id and file_id are required parameters in the payload to create a transfer action.
1929
+ type: object
1930
+ properties:
1931
+ data:
1932
+ description: Data in the payload
1933
+ type: object
1934
+ properties:
1935
+ content_encryption:
1936
+ description: Encryption information
1937
+ type: object
1938
+ properties:
1939
+ encryption:
1940
+ description: Method of content encryption.
1941
+ type: string
1942
+ examples:
1943
+ - AES-128
1944
+ default: none
1945
+ enum:
1946
+ - AES-128
1947
+ - AES-256
1948
+ - AES-192
1949
+ - none
1950
+ apply_protection:
1951
+ description: Apply protection to the file transfer
1952
+ type: boolean
1953
+ examples:
1954
+ - true
1955
+ password:
1956
+ description: Password for the transfer, used if the value of apply_protection is true.
1957
+ type: string
1958
+ examples:
1959
+ - lHF%SHJrjk
1960
+ destination:
1961
+ description: Object with details about destination
1962
+ type: object
1963
+ properties:
1964
+ file_id:
1965
+ description: ID of file to be transferred. Required for a transfer source that is a workspace or node.
1966
+ type: string
1967
+ examples:
1968
+ - '1818255'
1969
+ file_name:
1970
+ description: Name of file to be transferred.
1971
+ type: string
1972
+ examples:
1973
+ - folder1
1974
+ node_id:
1975
+ description: ID of destination node. Required for a transfer source that is a workspace or node.
1976
+ type: string
1977
+ examples:
1978
+ - '95'
1979
+ node_name:
1980
+ description: Name of the destination node.
1981
+ type: string
1982
+ examples:
1983
+ - Tor02_node
1984
+ paths:
1985
+ description: Array of objects that contain destination paths for transfer
1986
+ type: array
1987
+ items:
1988
+ $ref: '#/components/schemas/Paths'
1989
+ type:
1990
+ description: 'Type of destination for transfer. Allowed values: workspace, node.'
1991
+ type: string
1992
+ examples:
1993
+ - workspace
1994
+ enum:
1995
+ - workspace
1996
+ - node
1997
+ workspace_id:
1998
+ description: ID of workspace at destination
1999
+ type: string
2000
+ examples:
2001
+ - '638'
2002
+ workspace_name:
2003
+ description: Name of workspace at destination
2004
+ type: string
2005
+ examples:
2006
+ - dev_workspace
2007
+ required:
2008
+ - node_id
2009
+ - file_id
2010
+ file_attributes:
2011
+ description: File attributes are defined
2012
+ type: boolean
2013
+ examples:
2014
+ - true
2015
+ conditions_type:
2016
+ description: 'The conditions type for the transfer. Allowed values: all_new (transfers all new files), custom (adds custom filtering conditions). Default: all-new.'
2017
+ type: string
2018
+ examples:
2019
+ - custom
2020
+ default: all_new
2021
+ enum:
2022
+ - custom
2023
+ - all_new
2024
+ join_type:
2025
+ description: 'The logical operator that joins multiple conditions. Allowed values: and, or.'
2026
+ type: string
2027
+ examples:
2028
+ - and
2029
+ enum:
2030
+ - and
2031
+ - or
2032
+ conditions:
2033
+ description: Filtering conditions for the transfer
2034
+ type: array
2035
+ items:
2036
+ $ref: '#/components/schemas/Conditions'
2037
+ resume_policy:
2038
+ description: Policy for resuming a transfer
2039
+ type: object
2040
+ properties:
2041
+ destination_file_options:
2042
+ description: 'Processing options for file at destination. Allowed values: overwrite_always, overwrite_both_newer_and_different, overwrite_different, overwrite_newer, overwrite_never.'
2043
+ type: string
2044
+ examples:
2045
+ - overwrite_always
2046
+ enum:
2047
+ - overwrite_always
2048
+ - overwrite_both_newer_and_different
2049
+ - overwrite_different
2050
+ - overwrite_newer
2051
+ - overwrite_never
2052
+ difference_check:
2053
+ description: 'Type of check used to validate content. Allowed values: attrs, none.'
2054
+ type: string
2055
+ examples:
2056
+ - attrs
2057
+ enum:
2058
+ - attrs
2059
+ - none
2060
+ resume_partials:
2061
+ description: Partial transfers should be resumed
2062
+ type: boolean
2063
+ examples:
2064
+ - true
2065
+ source:
2066
+ description: Source of the transfer
2067
+ type: object
2068
+ properties:
2069
+ type:
2070
+ description: 'Source type. Allowed values: workspace, node.'
2071
+ type: string
2072
+ examples:
2073
+ - node
2074
+ enum:
2075
+ - workspace
2076
+ - node
2077
+ file_id:
2078
+ description: ID of file that is transferred
2079
+ type: string
2080
+ examples:
2081
+ - '1730980'
2082
+ file_name:
2083
+ description: Name of file that is transferred
2084
+ type: string
2085
+ examples:
2086
+ - 01-test
2087
+ node_id:
2088
+ description: ID of the source node.
2089
+ type: string
2090
+ examples:
2091
+ - '95'
2092
+ node_name:
2093
+ description: Name of the source node.
2094
+ type: string
2095
+ examples:
2096
+ - Tor02_node
2097
+ paths:
2098
+ description: Array of objects that contain source paths for transfer
2099
+ type: array
2100
+ items:
2101
+ $ref: '#/components/schemas/Paths'
2102
+ token:
2103
+ description: Token for the transfer
2104
+ type: string
2105
+ examples:
2106
+ - <token>
2107
+ required:
2108
+ - node_id
2109
+ - file_id
2110
+ - paths
2111
+ source_archive:
2112
+ description: Archive policy for the transfer source
2113
+ type: object
2114
+ properties:
2115
+ archive_option:
2116
+ description: 'Archive policy for the package at the source. Allowed values: none, archive, delete.'
2117
+ type: string
2118
+ examples:
2119
+ - none
2120
+ enum:
2121
+ - none
2122
+ - archive
2123
+ - delete
2124
+ delete_empty_subdirectories:
2125
+ description: Delete empty subdirectories at source after transfer
2126
+ type: boolean
2127
+ examples:
2128
+ - false
2129
+ move_after_transfer:
2130
+ description: Archive location in case of archiving. (location relative to source path)
2131
+ type: string
2132
+ examples:
2133
+ - /abc/def
2134
+ remove_skipped:
2135
+ description: Archive location in case of delete source. to remove the skipped files
2136
+ type: boolean
2137
+ examples:
2138
+ - true
2139
+ substitutions:
2140
+ description: Data for substitution variables from previous steps, inserted into the message
2141
+ type: array
2142
+ items:
2143
+ $ref: '#/components/schemas/substitutionVariables'
2144
+ timeout:
2145
+ description: 'The maximum time, in seconds, the action can take before it is marked as failed. Default: 24 hours, minimum: 1 hour, maximum: 48 hours.'
2146
+ type: integer
2147
+ examples:
2148
+ - 144000
2149
+ default: 86400
2150
+ minimum: 3600
2151
+ maximum: 172800
2152
+ target_rate:
2153
+ description: Rate and retry conditions for the transfer
2154
+ type: object
2155
+ properties:
2156
+ rate:
2157
+ description: Transfer rate, in bytes per second
2158
+ type: integer
2159
+ examples:
2160
+ - 10000
2161
+ default: 10000
2162
+ allow_retry:
2163
+ description: Whether to allow retry of a failed transfer
2164
+ type: boolean
2165
+ examples:
2166
+ - true
2167
+ default: true
2168
+ retry_attempts:
2169
+ description: Number of times Automation can retry the transfer
2170
+ type: integer
2171
+ examples:
2172
+ - 3
2173
+ default: 3
2174
+ retry_interval:
2175
+ description: Length of time to wait before retrying the transfer, in seconds
2176
+ type: integer
2177
+ examples:
2178
+ - 30
2179
+ default: 30
2180
+ required:
2181
+ - source
2182
+ - destination
2183
+ step_id:
2184
+ description: ID for step that contains the action
2185
+ type: string
2186
+ examples:
2187
+ - '1314'
2188
+ type:
2189
+ description: Action type. For an action that transfers a file, the type is always transfer.
2190
+ type: string
2191
+ examples:
2192
+ - transfer
2193
+ enum:
2194
+ - transfer
2195
+ required:
2196
+ - data
2197
+ - type
2198
+ - step_id
2199
+ title: Creates a new action to send a file or folder
2200
+ Conditions:
2201
+ type: object
2202
+ properties:
2203
+ field_name:
2204
+ description: 'Name of the condition field. Allowed values: file_name, extension_name, file_size'
2205
+ type: string
2206
+ examples:
2207
+ - file_name
2208
+ enum:
2209
+ - file_name
2210
+ - extension_name
2211
+ - file_size
2212
+ field_type:
2213
+ description: 'Type of the condition field. Allowed values: string, byte. The value ''string'' is used with a field_name of file_name or extension_name. The value ''byte'' is used with a field_name of file_size.'
2214
+ type: string
2215
+ examples:
2216
+ - string
2217
+ enum:
2218
+ - string
2219
+ - byte
2220
+ match_type:
2221
+ description: 'Logic for the matching condition. Allowed values: includes, excludes, matches, regex, equal, greater_than, less_than, greater_than_or_equal, less_than_or_equal. A value of includes, excludes, matches, or regex is used with a field_name of file_name or extension_name. A value of equal, greater_than, less_than, greater_than_or_equal or less_than_or_equal is used with a field_name of file_size.'
2222
+ type: string
2223
+ examples:
2224
+ - includes
2225
+ enum:
2226
+ - includes
2227
+ - excludes
2228
+ - matches
2229
+ - regex
2230
+ - equal
2231
+ - greater_than
2232
+ - less_than
2233
+ - greater_than_or_equal
2234
+ - less_than_or_equal
2235
+ value:
2236
+ description: Value of the condition
2237
+ type: string
2238
+ examples:
2239
+ - .jpg
2240
+ size:
2241
+ description: Size of file being transferred, in bytes
2242
+ type: integer
2243
+ examples:
2244
+ - 500000
2245
+ required:
2246
+ - field_name
2247
+ - field_type
2248
+ - match_type
2249
+ - value
2250
+ Recipients:
2251
+ type: object
2252
+ properties:
2253
+ id:
2254
+ description: Recipient ID
2255
+ type: string
2256
+ examples:
2257
+ - '3201'
2258
+ type:
2259
+ description: 'User type of recipient. Allowed values: user, admin.'
2260
+ type: string
2261
+ examples:
2262
+ - user
2263
+ enum:
2264
+ - user
2265
+ - admin
2266
+ name:
2267
+ description: Name of recipient
2268
+ type: string
2269
+ examples:
2270
+ - Adam Smith
2271
+ required:
2272
+ - id
2273
+ - type
2274
+ bccRecipients:
2275
+ description: Properties of user (recipient) who receives notification that the package is sent
2276
+ type: object
2277
+ properties:
2278
+ id:
2279
+ description: Recipient ID
2280
+ type: string
2281
+ examples:
2282
+ - '3202'
2283
+ type:
2284
+ description: 'User type of recipient. Allowed values: user, admin.'
2285
+ type: string
2286
+ examples:
2287
+ - admin
2288
+ enum:
2289
+ - user
2290
+ - admin
2291
+ name:
2292
+ description: Name of recipient
2293
+ type: string
2294
+ examples:
2295
+ - Benita Tyme
2296
+ required:
2297
+ - id
2298
+ - type
2299
+ uploadNotificationRecipients:
2300
+ description: Properties of user (recipient) who receives notification that the package is sent
2301
+ type: object
2302
+ properties:
2303
+ id:
2304
+ description: Recipient ID
2305
+ type: string
2306
+ examples:
2307
+ - '3203'
2308
+ type:
2309
+ description: 'User type of recipient. Allowed values: user, admin.'
2310
+ type: string
2311
+ examples:
2312
+ - admin
2313
+ enum:
2314
+ - user
2315
+ - admin
2316
+ name:
2317
+ description: Name of recipient
2318
+ type: string
2319
+ examples:
2320
+ - Constance Upshaw
2321
+ required:
2322
+ - id
2323
+ - type
2324
+ downloadNotificationRecipients:
2325
+ description: Properties of user (recipient) who receives notification that the package is sent
2326
+ type: object
2327
+ properties:
2328
+ id:
2329
+ description: Recipient ID
2330
+ type: string
2331
+ examples:
2332
+ - '3204'
2333
+ type:
2334
+ description: 'User type of recipient. Allowed values: user, admin.'
2335
+ type: string
2336
+ examples:
2337
+ - user
2338
+ enum:
2339
+ - user
2340
+ - admin
2341
+ name:
2342
+ description: Name of recipient
2343
+ type: string
2344
+ examples:
2345
+ - David Vale
2346
+ required:
2347
+ - id
2348
+ - type
2349
+ Paths:
2350
+ description: Source paths for the transfer
2351
+ type: object
2352
+ properties:
2353
+ source:
2354
+ description: Describes the source path. If "/", all files transfer from the same folder location.
2355
+ type: string
2356
+ examples:
2357
+ - /
2358
+ required:
2359
+ - source
2360
+ title: Paths
2361
+ updateState:
2362
+ type: object
2363
+ properties:
2364
+ event:
2365
+ description: 'Request a state change. Allowed values: save_as_draft, activate, deactivate. To save a workflow in a state that can be edited, use ''save_as_draft''. To launch running instances of the workflow, use ''activate''. To stop all running instances of a workflow, use ''deactivate''; this event allows you to edit the workflow.'
2366
+ type: string
2367
+ examples:
2368
+ - save_as_draft
2369
+ enum:
2370
+ - save_as_draft
2371
+ - activate
2372
+ - deactivate
2373
+ required:
2374
+ - event
2375
+ title: Updates the state of the workflow
2376
+ updateWorkflowPermissionRequest:
2377
+ type: object
2378
+ properties:
2379
+ duplicate:
2380
+ description: Whether to give permission to duplicate the workflow
2381
+ type: boolean
2382
+ examples:
2383
+ - true
2384
+ manage_jobs:
2385
+ description: Whether to give permission to manage workflow jobs
2386
+ type: boolean
2387
+ examples:
2388
+ - true
2389
+ title: Updates an existing workflow permission
2390
+ securitySchemes:
2391
+ bearerAuth:
2392
+ type: http
2393
+ scheme: bearer
2394
+ bearerFormat: JWT
2395
+ description: JSON Web Token (bearer token) in the Authorization header