aspera-cli 4.28.0 → 4.29.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.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/BUGS.md +5 -10
- data/CHANGELOG.md +143 -2
- data/CODE_OF_CONDUCT.md +18 -0
- data/CONTRIBUTING.md +135 -56
- data/GOVERNANCE.md +30 -0
- data/LICENSE +201 -0
- data/README.md +103 -26
- data/SECURITY.md +70 -0
- data/bin/ascli +8 -5
- data/bin/asession +9 -6
- data/docs/README.md +1633 -609
- data/docs/test-mcp-with-ai.md +8 -8
- data/lib/aspera/agent/base.rb +23 -2
- data/lib/aspera/agent/connect.rb +16 -12
- data/lib/aspera/agent/desktop.rb +10 -7
- data/lib/aspera/agent/direct.rb +20 -19
- data/lib/aspera/agent/factory.rb +6 -3
- data/lib/aspera/agent/httpgw.rb +7 -5
- data/lib/aspera/agent/node.rb +15 -7
- data/lib/aspera/agent/transferd.rb +167 -43
- data/lib/aspera/api/alee.rb +4 -1
- data/lib/aspera/api/aoc.rb +14 -11
- data/lib/aspera/api/ats.rb +4 -2
- data/lib/aspera/api/cos_node.rb +7 -4
- data/lib/aspera/api/faspex.rb +16 -9
- data/lib/aspera/api/httpgw.rb +9 -6
- data/lib/aspera/api/node.rb +20 -20
- data/lib/aspera/ascmd.rb +8 -5
- data/lib/aspera/ascp/installation.rb +71 -65
- data/lib/aspera/ascp/log.schema.yaml +1084 -0
- data/lib/aspera/ascp/log_analyzer/advice.rb +97 -0
- data/lib/aspera/ascp/log_analyzer/diagnostics.rb +344 -0
- data/lib/aspera/ascp/log_analyzer/lines.rb +75 -0
- data/lib/aspera/ascp/log_analyzer/log_file.rb +593 -0
- data/lib/aspera/ascp/log_analyzer/records.rb +379 -0
- data/lib/aspera/ascp/log_analyzer/rules.rb +172 -0
- data/lib/aspera/ascp/log_analyzer/session.rb +782 -0
- data/lib/aspera/ascp/log_analyzer.rb +354 -0
- data/lib/aspera/ascp/management.rb +16 -8
- data/lib/aspera/ascp/session_errors.rb +217 -0
- data/lib/aspera/assert.rb +4 -0
- data/lib/aspera/cli/ascp_actions.rb +12 -19
- data/lib/aspera/cli/ascp_logs_actions.rb +176 -0
- data/lib/aspera/cli/async_transfer_store.rb +7 -4
- data/lib/aspera/cli/bootstrapper.rb +37 -33
- data/lib/aspera/cli/command_line.rb +24 -6
- data/lib/aspera/cli/command_registry.rb +6 -1
- data/lib/aspera/cli/command_spec.rb +34 -7
- data/lib/aspera/cli/completion/ascli.bash +19 -5
- data/lib/aspera/cli/completion/ascli.fish +13 -2
- data/lib/aspera/cli/completion/ascli.ps1 +31 -9
- data/lib/aspera/cli/completion/ascli.zsh +22 -6
- data/lib/aspera/cli/completion_actions.rb +303 -69
- data/lib/aspera/cli/context.rb +9 -4
- data/lib/aspera/cli/deprecation.rb +5 -2
- data/lib/aspera/cli/error.rb +3 -0
- data/lib/aspera/cli/extended_value.rb +61 -27
- data/lib/aspera/cli/formatter.rb +29 -22
- data/lib/aspera/cli/gem_checker.rb +9 -6
- data/lib/aspera/cli/hints.rb +22 -10
- data/lib/aspera/cli/http.rb +12 -9
- data/lib/aspera/cli/info.rb +12 -7
- data/lib/aspera/cli/mailer.rb +6 -3
- data/lib/aspera/cli/mcp/http_servlet.rb +7 -8
- data/lib/aspera/cli/mcp/secrets.rb +8 -5
- data/lib/aspera/cli/mcp/tool.rb +15 -14
- data/lib/aspera/cli/option_declarator.rb +10 -4
- data/lib/aspera/cli/option_registry.rb +6 -3
- data/lib/aspera/cli/option_types.rb +17 -2
- data/lib/aspera/cli/option_value.rb +65 -12
- data/lib/aspera/cli/options.schema.yaml +487 -63
- data/lib/aspera/cli/parser.rb +56 -32
- data/lib/aspera/cli/plugins/alee.rb +7 -4
- data/lib/aspera/cli/plugins/aoc.rb +244 -35
- data/lib/aspera/cli/plugins/ats.rb +9 -8
- data/lib/aspera/cli/plugins/base.rb +17 -12
- data/lib/aspera/cli/plugins/basic_auth.rb +5 -2
- data/lib/aspera/cli/plugins/config.rb +198 -103
- data/lib/aspera/cli/plugins/console.rb +6 -3
- data/lib/aspera/cli/plugins/cos.rb +8 -4
- data/lib/aspera/cli/plugins/factory.rb +21 -7
- data/lib/aspera/cli/plugins/faspex5.rb +28 -25
- data/lib/aspera/cli/plugins/faspio.rb +7 -5
- data/lib/aspera/cli/plugins/httpgw.rb +7 -4
- data/lib/aspera/cli/plugins/mcp.rb +28 -22
- data/lib/aspera/cli/plugins/node.rb +31 -30
- data/lib/aspera/cli/plugins/oauth.rb +5 -1
- data/lib/aspera/cli/plugins/orchestrator.rb +272 -72
- data/lib/aspera/cli/plugins/preview.rb +69 -44
- data/lib/aspera/cli/plugins/server.rb +63 -11
- data/lib/aspera/cli/plugins/shares.rb +86 -16
- data/lib/aspera/cli/plugins/transferd.rb +223 -0
- data/lib/aspera/cli/preset_actions.rb +144 -30
- data/lib/aspera/cli/preset_manager.rb +52 -18
- data/lib/aspera/cli/prompt.rb +4 -1
- data/lib/aspera/cli/result.rb +12 -8
- data/lib/aspera/cli/runner.rb +69 -46
- data/lib/aspera/cli/secret_finder.rb +4 -1
- data/lib/aspera/cli/security.rb +79 -9
- data/lib/aspera/cli/special_values.rb +4 -1
- data/lib/aspera/cli/sync_actions.rb +13 -10
- data/lib/aspera/cli/table_fitter.rb +3 -0
- data/lib/aspera/cli/terminal_formatter.rb +9 -6
- data/lib/aspera/cli/transfer_actions.rb +11 -8
- data/lib/aspera/cli/transfer_agent.rb +29 -20
- data/lib/aspera/cli/transfer_progress.rb +13 -45
- data/lib/aspera/cli/vault_actions.rb +45 -0
- data/lib/aspera/cli/vault_manager.rb +188 -42
- data/lib/aspera/cli/version.rb +4 -1
- data/lib/aspera/cli/web_secret.rb +12 -10
- data/lib/aspera/cli/wizard.rb +42 -39
- data/lib/aspera/command_line_builder.rb +9 -5
- data/lib/aspera/command_line_converter.rb +4 -1
- data/lib/aspera/coverage.rb +103 -33
- data/lib/aspera/data_repository.rb +4 -1
- data/lib/aspera/dot_container.rb +4 -1
- data/lib/aspera/duration.rb +5 -2
- data/lib/aspera/environment.rb +21 -12
- data/lib/aspera/exec_spec.rb +3 -0
- data/lib/aspera/faspex_gw.rb +13 -9
- data/lib/aspera/faspex_postproc.rb +15 -12
- data/lib/aspera/formatter_interface.rb +4 -1
- data/lib/aspera/graphql.rb +5 -1
- data/lib/aspera/hash_ext.rb +3 -0
- data/lib/aspera/id_generator.rb +4 -2
- data/lib/aspera/json_rpc/client.rb +6 -5
- data/lib/aspera/json_rpc/version.rb +3 -0
- data/lib/aspera/line_logger.rb +4 -1
- data/lib/aspera/link_header.rb +4 -1
- data/lib/aspera/log.rb +18 -5
- data/lib/aspera/markdown.rb +5 -2
- data/lib/aspera/mime.rb +3 -0
- data/lib/aspera/nagios.rb +6 -4
- data/lib/aspera/node_emulator.rb +15 -13
- data/lib/aspera/oauth/client/base.rb +91 -70
- data/lib/aspera/oauth/client/boot.rb +7 -4
- data/lib/aspera/oauth/client/factory.rb +6 -3
- data/lib/aspera/oauth/client/generic.rb +5 -1
- data/lib/aspera/oauth/client/json_credentials.rb +4 -1
- data/lib/aspera/oauth/client/jwt.rb +6 -3
- data/lib/aspera/oauth/client/shares_web.rb +85 -0
- data/lib/aspera/oauth/client/url_json.rb +4 -1
- data/lib/aspera/oauth/client/web.rb +39 -12
- data/lib/aspera/oauth/server/pkce.rb +6 -5
- data/lib/aspera/orchestrator_workflow_checker.rb +119 -1
- data/lib/aspera/persistency_action_once.rb +5 -3
- data/lib/aspera/persistency_folder.rb +6 -3
- data/lib/aspera/preview/file_types.rb +6 -3
- data/lib/aspera/preview/generator.rb +9 -5
- data/lib/aspera/preview/options.schema.yaml +3 -3
- data/lib/aspera/preview/terminal.rb +8 -4
- data/lib/aspera/preview/utils.rb +6 -4
- data/lib/aspera/products/connect.rb +5 -2
- data/lib/aspera/products/desktop.rb +4 -1
- data/lib/aspera/products/other.rb +4 -2
- data/lib/aspera/products/transferd.rb +6 -2
- data/lib/aspera/products/transferd_service.rb +610 -0
- data/lib/aspera/proxy_auto_config.js +2 -2
- data/lib/aspera/proxy_auto_config.rb +5 -2
- data/lib/aspera/rainbow.rb +3 -0
- data/lib/aspera/rest/aspera_errors.rb +4 -1
- data/lib/aspera/rest/call_error.rb +3 -0
- data/lib/aspera/rest/client.rb +22 -29
- data/lib/aspera/rest/error_analyzer.rb +5 -2
- data/lib/aspera/rest/list.rb +8 -4
- data/lib/aspera/rest/parameters.rb +3 -0
- data/lib/aspera/rest/util.rb +8 -5
- data/lib/aspera/rest.rb +9 -6
- data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +9 -9
- data/lib/aspera/schema/IBM Aspera Orchestrator API-v1-enhanced.yaml +118 -30
- data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml +11 -11
- data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml +2437 -1437
- data/lib/aspera/schema/async_tables.yaml +11 -10
- data/lib/aspera/schema/documentation.rb +8 -2
- data/lib/aspera/schema/reader.rb +7 -0
- data/lib/aspera/schema/registry.rb +43 -28
- data/lib/aspera/schema/transferd-config.schema.json +333 -0
- data/lib/aspera/schema/validator.rb +4 -1
- data/lib/aspera/sealed_hash.rb +166 -0
- data/lib/aspera/secret/hider.rb +201 -0
- data/lib/aspera/secret/reference.rb +150 -0
- data/lib/aspera/secret/resolver.rb +212 -0
- data/lib/aspera/secret/store/base.rb +153 -0
- data/lib/aspera/secret/store/encrypted_hash.rb +329 -0
- data/lib/aspera/secret/store/factory.rb +103 -0
- data/lib/aspera/secret/store/hashicorp_vault.rb +390 -0
- data/lib/aspera/secret/store/keeper.rb +141 -0
- data/lib/aspera/secret/store/macos_security.rb +284 -0
- data/lib/aspera/secret/store/one_password_api.rb +99 -0
- data/lib/aspera/secret/store/one_password_base.rb +42 -0
- data/lib/aspera/secret/store/one_password_cli.rb +110 -0
- data/lib/aspera/secret/store/secret_service.rb +125 -0
- data/lib/aspera/secret/strength.rb +119 -0
- data/lib/aspera/servlet_helpers.rb +5 -2
- data/lib/aspera/ssh.rb +10 -7
- data/lib/aspera/ssl.rb +5 -2
- data/lib/aspera/string_ext.rb +3 -0
- data/lib/aspera/sync/args.schema.yaml +3 -0
- data/lib/aspera/sync/conf.schema.yaml +9 -4
- data/lib/aspera/sync/database.rb +3 -0
- data/lib/aspera/sync/operations.rb +16 -14
- data/lib/aspera/temp_file_manager.rb +8 -4
- data/lib/aspera/timer_limiter.rb +3 -0
- data/lib/aspera/transfer/error.rb +4 -1
- data/lib/aspera/transfer/faux_file.rb +4 -1
- data/lib/aspera/transfer/parameters.rb +17 -14
- data/lib/aspera/transfer/result.rb +3 -0
- data/lib/aspera/transfer/resumer.rb +6 -4
- data/lib/aspera/transfer/spec.rb +9 -22
- data/lib/aspera/transfer/units.rb +75 -0
- data/lib/aspera/uri_reader.rb +57 -7
- data/lib/aspera/web_auth/index.html.erb +6 -2
- data/lib/aspera/web_auth/paste.rb +109 -0
- data/lib/aspera/web_auth/receiver.rb +50 -0
- data/lib/aspera/web_auth/relay.rb +76 -0
- data/lib/aspera/web_auth/reply.html.erb +150 -0
- data/lib/aspera/web_auth/server.rb +47 -10
- data/lib/aspera/web_page.rb +7 -2
- data/lib/aspera/web_server_simple.rb +6 -3
- data/lib/aspera/yaml.rb +5 -1
- data/llms.txt +81 -0
- data/skills/ascli/SKILL.md +88 -0
- data.tar.gz.sig +0 -0
- metadata +72 -19
- metadata.gz.sig +0 -0
- data/lib/aspera/keychain/base.rb +0 -30
- data/lib/aspera/keychain/encrypted_hash.rb +0 -192
- data/lib/aspera/keychain/factory.rb +0 -58
- data/lib/aspera/keychain/hashicorp_vault.rb +0 -77
- data/lib/aspera/keychain/macos_security.rb +0 -277
- data/lib/aspera/keychain/one_password_api.rb +0 -91
- data/lib/aspera/keychain/one_password_base.rb +0 -39
- data/lib/aspera/keychain/one_password_cli.rb +0 -100
- data/lib/aspera/secret_hider.rb +0 -196
- data/lib/aspera/secret_strength.rb +0 -114
|
@@ -9,9 +9,9 @@ info:
|
|
|
9
9
|
description: |-
|
|
10
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
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:
|
|
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. Identifiers are numeric strings. After you activate the workflow, you can monitor active jobs and update the state of the workflow, which allows you to make edits. Note: To be activated, a workflow must have at least two steps, and contain an action that transfers a file or sends a package.
|
|
13
13
|
|
|
14
|
-
Access Control: You must include a JSON Web Token (bearer token) in the authorization header of your request.
|
|
14
|
+
Access Control: You must include a JSON Web Token (bearer token) in the authorization header of your request. The token must give access to the Automation application. Except for the administrator scope, a user acts only on the workflows shared with them (`edit`, `manage_jobs` or `duplicate` permission).
|
|
15
15
|
|
|
16
16
|
For additional information, visit the Aspera Developer Center at https://developer.ibm.com/aspera/
|
|
17
17
|
version: 1.0.5
|
|
@@ -34,12 +34,25 @@ tags:
|
|
|
34
34
|
description: Actions within a step
|
|
35
35
|
- name: workflow_permissions
|
|
36
36
|
description: Permissions on workflows
|
|
37
|
+
- name: app_permissions
|
|
38
|
+
description: Application settings and permissions
|
|
39
|
+
- name: external
|
|
40
|
+
description: Callbacks and health check, without authentication
|
|
37
41
|
paths:
|
|
38
42
|
/workflows:
|
|
39
43
|
get:
|
|
40
44
|
operationId: listWorkflows
|
|
41
45
|
summary: Get workflows
|
|
42
|
-
description: Returns all workflows.
|
|
46
|
+
description: Returns the workflows on which the caller has a permission. With `show_org_workflows=true` and an administrator token, returns all the non-hidden workflows of the organization. Hidden workflows are never listed. `user_id` and `organization_id` are taken from the bearer token when it carries them.
|
|
47
|
+
parameters:
|
|
48
|
+
- $ref: '#/components/parameters/offset'
|
|
49
|
+
- $ref: '#/components/parameters/limit'
|
|
50
|
+
- $ref: '#/components/parameters/q'
|
|
51
|
+
- $ref: '#/components/parameters/sort'
|
|
52
|
+
- $ref: '#/components/parameters/show_org_workflows'
|
|
53
|
+
- $ref: '#/components/parameters/user_id'
|
|
54
|
+
- $ref: '#/components/parameters/organization_id'
|
|
55
|
+
- $ref: '#/components/parameters/response_type'
|
|
43
56
|
responses:
|
|
44
57
|
'200':
|
|
45
58
|
description: OK - Successful response
|
|
@@ -47,19 +60,18 @@ paths:
|
|
|
47
60
|
application/json:
|
|
48
61
|
schema:
|
|
49
62
|
$ref: '#/components/schemas/200-Workflows'
|
|
63
|
+
'401':
|
|
64
|
+
$ref: '#/components/responses/Unauthorized'
|
|
50
65
|
'403':
|
|
51
|
-
|
|
52
|
-
'
|
|
53
|
-
|
|
66
|
+
$ref: '#/components/responses/Forbidden'
|
|
67
|
+
'422':
|
|
68
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
54
69
|
tags:
|
|
55
70
|
- workflows
|
|
56
|
-
parameters:
|
|
57
|
-
- $ref: '#/components/parameters/offset'
|
|
58
|
-
- $ref: '#/components/parameters/limit'
|
|
59
71
|
post:
|
|
60
72
|
operationId: createWorkflow
|
|
61
73
|
summary: Create a workflow
|
|
62
|
-
description: Creates a new workflow. Once you have created the workflow,
|
|
74
|
+
description: Creates a new workflow in the `draft` state. Once you have created the workflow, create its steps, then add each step to the workflow `step_order` with a PUT request, before creating the actions of the step. The trigger type of the workflow is that of the first action of the first step.
|
|
63
75
|
requestBody:
|
|
64
76
|
required: true
|
|
65
77
|
content:
|
|
@@ -75,30 +87,28 @@ paths:
|
|
|
75
87
|
$ref: '#/components/schemas/201-Workflow'
|
|
76
88
|
'400':
|
|
77
89
|
description: Bad Request. The payload may not be in the correct format (JSON format).
|
|
90
|
+
'401':
|
|
91
|
+
$ref: '#/components/responses/Unauthorized'
|
|
78
92
|
'403':
|
|
79
|
-
|
|
93
|
+
$ref: '#/components/responses/Forbidden'
|
|
80
94
|
'422':
|
|
81
|
-
|
|
95
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
82
96
|
tags:
|
|
83
97
|
- workflows
|
|
84
98
|
/workflows/{id}:
|
|
85
99
|
get:
|
|
86
100
|
operationId: getWorkflow
|
|
87
101
|
summary: Gets a workflow
|
|
88
|
-
description: Returns a workflow with a unique ID.
|
|
102
|
+
description: Returns a workflow with a unique ID, with its steps. Requires a permission on the workflow, or the administrator scope. A hidden workflow is not accessible.
|
|
89
103
|
parameters:
|
|
90
|
-
-
|
|
91
|
-
in: path
|
|
92
|
-
description: Numeric ID of the workflow to get
|
|
93
|
-
required: true
|
|
94
|
-
schema:
|
|
95
|
-
type: string
|
|
104
|
+
- $ref: '#/components/parameters/workflowIdPath'
|
|
96
105
|
- name: workflow_version_id
|
|
97
106
|
in: query
|
|
98
|
-
description: Numeric ID of the workflow version to get
|
|
107
|
+
description: Numeric ID of the workflow version to get. The state, status, statistics and `workflow_can_activate` are not returned for a version.
|
|
99
108
|
required: false
|
|
100
109
|
schema:
|
|
101
110
|
type: string
|
|
111
|
+
- $ref: '#/components/parameters/response_type'
|
|
102
112
|
responses:
|
|
103
113
|
'200':
|
|
104
114
|
description: OK - Successful response
|
|
@@ -106,23 +116,20 @@ paths:
|
|
|
106
116
|
application/json:
|
|
107
117
|
schema:
|
|
108
118
|
$ref: '#/components/schemas/workflowData'
|
|
119
|
+
'401':
|
|
120
|
+
$ref: '#/components/responses/Unauthorized'
|
|
109
121
|
'403':
|
|
110
|
-
|
|
111
|
-
'
|
|
112
|
-
|
|
122
|
+
$ref: '#/components/responses/Forbidden'
|
|
123
|
+
'404':
|
|
124
|
+
$ref: '#/components/responses/NotFound'
|
|
113
125
|
tags:
|
|
114
126
|
- workflows
|
|
115
127
|
put:
|
|
116
128
|
operationId: updateWorkflow
|
|
117
129
|
summary: Update a workflow
|
|
118
|
-
description:
|
|
130
|
+
description: Edits a workflow with a unique ID. Requires the `edit` permission on the workflow. The ID of the user and of the organization are taken from the bearer token.
|
|
119
131
|
parameters:
|
|
120
|
-
-
|
|
121
|
-
in: path
|
|
122
|
-
description: Numeric ID of the workflow to update
|
|
123
|
-
required: true
|
|
124
|
-
schema:
|
|
125
|
-
type: string
|
|
132
|
+
- $ref: '#/components/parameters/workflowIdPath'
|
|
126
133
|
requestBody:
|
|
127
134
|
required: true
|
|
128
135
|
content:
|
|
@@ -134,42 +141,49 @@ paths:
|
|
|
134
141
|
description: No Content
|
|
135
142
|
'400':
|
|
136
143
|
description: Bad Request. The payload may not be in the correct format (JSON format).
|
|
144
|
+
'401':
|
|
145
|
+
$ref: '#/components/responses/Unauthorized'
|
|
137
146
|
'403':
|
|
138
|
-
|
|
147
|
+
$ref: '#/components/responses/Forbidden'
|
|
148
|
+
'404':
|
|
149
|
+
$ref: '#/components/responses/NotFound'
|
|
139
150
|
'422':
|
|
140
|
-
|
|
151
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
141
152
|
tags:
|
|
142
153
|
- workflows
|
|
143
154
|
delete:
|
|
144
155
|
operationId: deleteWorkflow
|
|
145
156
|
summary: Delete a workflow
|
|
146
|
-
description:
|
|
157
|
+
description: Deletes a workflow with a unique ID. Requires the administrator scope or the `edit` permission. Fails with 422 while a job of the workflow is executing, initiating or queued; cancel the jobs first.
|
|
147
158
|
parameters:
|
|
148
|
-
-
|
|
149
|
-
in: path
|
|
150
|
-
description: Numeric ID of the workflow to delete
|
|
151
|
-
required: true
|
|
152
|
-
schema:
|
|
153
|
-
type: string
|
|
159
|
+
- $ref: '#/components/parameters/workflowIdPath'
|
|
154
160
|
responses:
|
|
155
161
|
'204':
|
|
156
162
|
description: No Content
|
|
163
|
+
'401':
|
|
164
|
+
$ref: '#/components/responses/Unauthorized'
|
|
157
165
|
'403':
|
|
158
|
-
|
|
166
|
+
$ref: '#/components/responses/Forbidden'
|
|
167
|
+
'404':
|
|
168
|
+
$ref: '#/components/responses/NotFound'
|
|
169
|
+
'422':
|
|
170
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
159
171
|
tags:
|
|
160
172
|
- workflows
|
|
161
173
|
/workflows/{id}/update_state:
|
|
162
174
|
put:
|
|
163
175
|
operationId: updateWorkflowState
|
|
164
176
|
summary: Update the workflow state
|
|
165
|
-
description:
|
|
177
|
+
description: |-
|
|
178
|
+
Fires a state event on a workflow with a unique ID.
|
|
179
|
+
|
|
180
|
+
- `activate`: from `draft` or `inactive`. A workflow in `draft` first goes to `validating`, then to `active` once the permissions on the nodes are granted. Fails with 422 if the workflow was never validated (status `not_started`), or if a scheduled trigger has a start date in the past.
|
|
181
|
+
- `deactivate`: from `active` to `inactive`. Running jobs are not stopped.
|
|
182
|
+
- `save_as_draft`: back to `draft`. Fails with 422 while the workflow is `validating`, or while a job is executing, initiating or queued.
|
|
183
|
+
|
|
184
|
+
`activate` and `deactivate` require the administrator scope or the `edit` permission; `save_as_draft` requires the `edit` permission.
|
|
166
185
|
parameters:
|
|
167
|
-
-
|
|
168
|
-
in: path
|
|
169
|
-
description: Numeric ID of the workflow to edit
|
|
170
|
-
required: true
|
|
171
|
-
schema:
|
|
172
|
-
type: string
|
|
186
|
+
- $ref: '#/components/parameters/workflowIdPath'
|
|
173
187
|
requestBody:
|
|
174
188
|
required: true
|
|
175
189
|
content:
|
|
@@ -183,100 +197,173 @@ paths:
|
|
|
183
197
|
description: No Content
|
|
184
198
|
'400':
|
|
185
199
|
description: Bad Request. The payload may not be in the correct format (JSON format).
|
|
200
|
+
'401':
|
|
201
|
+
$ref: '#/components/responses/Unauthorized'
|
|
186
202
|
'403':
|
|
187
|
-
|
|
203
|
+
$ref: '#/components/responses/Forbidden'
|
|
204
|
+
'404':
|
|
205
|
+
$ref: '#/components/responses/NotFound'
|
|
188
206
|
'422':
|
|
189
|
-
|
|
207
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
190
208
|
tags:
|
|
191
209
|
- workflows
|
|
192
210
|
/workflows/{id}/launch:
|
|
193
211
|
post:
|
|
194
212
|
operationId: launchWorkflow
|
|
195
213
|
summary: Launch a workflow
|
|
196
|
-
description:
|
|
214
|
+
description: Launches a job of an `active` workflow. Only workflows with a `manual` or `scheduled` trigger can be launched; a `watch_folder`, `shared_inbox` or `delete_folder` trigger returns 422. A `scheduled` workflow that already has a running job returns 422. Requires the administrator scope, or the `manage_jobs` or `edit` permission.
|
|
197
215
|
parameters:
|
|
198
|
-
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
216
|
+
- $ref: '#/components/parameters/workflowIdPath'
|
|
217
|
+
responses:
|
|
218
|
+
'200':
|
|
219
|
+
description: The launch request was accepted; the workflow engine executes the job.
|
|
220
|
+
content:
|
|
221
|
+
application/json:
|
|
222
|
+
schema:
|
|
223
|
+
$ref: '#/components/schemas/LaunchResponse'
|
|
224
|
+
'401':
|
|
225
|
+
$ref: '#/components/responses/Unauthorized'
|
|
226
|
+
'403':
|
|
227
|
+
$ref: '#/components/responses/Forbidden'
|
|
228
|
+
'404':
|
|
229
|
+
$ref: '#/components/responses/NotFound'
|
|
230
|
+
'422':
|
|
231
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
232
|
+
tags:
|
|
233
|
+
- workflows
|
|
234
|
+
/workflows/{id}/pause_all:
|
|
235
|
+
put:
|
|
236
|
+
operationId: pauseWorkflowInstances
|
|
237
|
+
summary: Pause all jobs
|
|
238
|
+
description: Same behavior as `cancel_instances`; the running jobs of the workflow are canceled. Requires the administrator scope, or the `manage_jobs` or `edit` permission.
|
|
239
|
+
parameters:
|
|
240
|
+
- $ref: '#/components/parameters/workflowIdPath'
|
|
205
241
|
responses:
|
|
206
242
|
'204':
|
|
207
243
|
description: No Content
|
|
208
|
-
'
|
|
209
|
-
|
|
244
|
+
'401':
|
|
245
|
+
$ref: '#/components/responses/Unauthorized'
|
|
210
246
|
'403':
|
|
211
|
-
|
|
247
|
+
$ref: '#/components/responses/Forbidden'
|
|
248
|
+
'404':
|
|
249
|
+
$ref: '#/components/responses/NotFound'
|
|
212
250
|
tags:
|
|
213
251
|
- workflows
|
|
214
252
|
/workflows/{id}/cancel_instances:
|
|
215
253
|
put:
|
|
216
254
|
operationId: cancelWorkflowInstances
|
|
217
255
|
summary: Cancel all jobs
|
|
218
|
-
description: Cancels all running jobs of
|
|
256
|
+
description: Cancels all running jobs of the workflow with a particular ID. Requires the administrator scope, or the `manage_jobs` or `edit` permission.
|
|
219
257
|
parameters:
|
|
220
|
-
-
|
|
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'
|
|
258
|
+
- $ref: '#/components/parameters/workflowIdPath'
|
|
227
259
|
responses:
|
|
228
260
|
'204':
|
|
229
261
|
description: No Content
|
|
230
|
-
'
|
|
231
|
-
|
|
262
|
+
'401':
|
|
263
|
+
$ref: '#/components/responses/Unauthorized'
|
|
232
264
|
'403':
|
|
233
|
-
|
|
265
|
+
$ref: '#/components/responses/Forbidden'
|
|
234
266
|
'404':
|
|
235
|
-
|
|
236
|
-
content:
|
|
237
|
-
application/json:
|
|
238
|
-
schema:
|
|
239
|
-
$ref: '#/components/schemas/404-Workflows'
|
|
267
|
+
$ref: '#/components/responses/NotFound'
|
|
240
268
|
tags:
|
|
241
269
|
- workflows
|
|
242
270
|
/workflows/{id}/delete_instances:
|
|
243
271
|
delete:
|
|
244
272
|
operationId: deleteWorkflowInstances
|
|
245
273
|
summary: Delete all jobs
|
|
246
|
-
description: Deletes all jobs
|
|
274
|
+
description: Deletes all jobs of the workflow with a particular ID. Requires the administrator scope, or the `manage_jobs` or `edit` permission.
|
|
247
275
|
parameters:
|
|
248
|
-
-
|
|
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'
|
|
276
|
+
- $ref: '#/components/parameters/workflowIdPath'
|
|
255
277
|
responses:
|
|
256
278
|
'204':
|
|
257
279
|
description: No Content
|
|
258
|
-
'
|
|
259
|
-
|
|
280
|
+
'401':
|
|
281
|
+
$ref: '#/components/responses/Unauthorized'
|
|
282
|
+
'403':
|
|
283
|
+
$ref: '#/components/responses/Forbidden'
|
|
284
|
+
'404':
|
|
285
|
+
$ref: '#/components/responses/NotFound'
|
|
286
|
+
tags:
|
|
287
|
+
- workflows
|
|
288
|
+
/workflows/{id}/default_copy_name:
|
|
289
|
+
get:
|
|
290
|
+
operationId: getWorkflowDefaultCopyName
|
|
291
|
+
summary: Get the default name of a copy
|
|
292
|
+
description: Returns the first free name of the form `<name> (<n>)` among the workflows of the user. Requires the administrator scope, or the `duplicate` or `edit` permission.
|
|
293
|
+
parameters:
|
|
294
|
+
- $ref: '#/components/parameters/workflowIdPath'
|
|
295
|
+
responses:
|
|
296
|
+
'200':
|
|
297
|
+
description: OK - Successful response
|
|
298
|
+
content:
|
|
299
|
+
application/json:
|
|
300
|
+
schema:
|
|
301
|
+
$ref: '#/components/schemas/DefaultCopyName'
|
|
302
|
+
'401':
|
|
303
|
+
$ref: '#/components/responses/Unauthorized'
|
|
260
304
|
'403':
|
|
261
|
-
|
|
305
|
+
$ref: '#/components/responses/Forbidden'
|
|
262
306
|
'404':
|
|
263
|
-
|
|
307
|
+
$ref: '#/components/responses/NotFound'
|
|
308
|
+
tags:
|
|
309
|
+
- workflows
|
|
310
|
+
/workflows/{id}/copy:
|
|
311
|
+
post:
|
|
312
|
+
operationId: copyWorkflow
|
|
313
|
+
summary: Duplicate a workflow
|
|
314
|
+
description: Creates a copy of a workflow, in the `draft` state, with a new name. Requires the administrator scope, or the `duplicate` or `edit` permission. Returns 422 while the status of the workflow is `submitted`.
|
|
315
|
+
parameters:
|
|
316
|
+
- $ref: '#/components/parameters/workflowIdPath'
|
|
317
|
+
requestBody:
|
|
318
|
+
required: true
|
|
319
|
+
content:
|
|
320
|
+
application/json:
|
|
321
|
+
schema:
|
|
322
|
+
type: object
|
|
323
|
+
properties:
|
|
324
|
+
name:
|
|
325
|
+
type: string
|
|
326
|
+
description: Name for the duplicated workflow
|
|
327
|
+
example: Copy of Send Files to Media
|
|
328
|
+
required:
|
|
329
|
+
- name
|
|
330
|
+
responses:
|
|
331
|
+
'200':
|
|
332
|
+
description: Successfully duplicated. The copy is returned with its steps and actions.
|
|
264
333
|
content:
|
|
265
334
|
application/json:
|
|
266
335
|
schema:
|
|
267
|
-
$ref: '#/components/schemas/
|
|
336
|
+
$ref: '#/components/schemas/workflowData'
|
|
337
|
+
'400':
|
|
338
|
+
description: Bad Request. The payload may not be in the correct format (JSON format).
|
|
339
|
+
'401':
|
|
340
|
+
$ref: '#/components/responses/Unauthorized'
|
|
341
|
+
'403':
|
|
342
|
+
$ref: '#/components/responses/Forbidden'
|
|
343
|
+
'404':
|
|
344
|
+
$ref: '#/components/responses/NotFound'
|
|
345
|
+
'422':
|
|
346
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
268
347
|
tags:
|
|
269
348
|
- workflows
|
|
270
349
|
/workflow_instances:
|
|
271
350
|
get:
|
|
272
351
|
operationId: listWorkflowInstances
|
|
273
352
|
summary: Get jobs
|
|
274
|
-
description: Returns
|
|
353
|
+
description: Returns the jobs, whether running, complete, or failed, of the non-hidden workflows on which the caller has a permission. With `show_org_workflow_instances=true` and an administrator token, returns the jobs of all the workflows of the organization. Deleted jobs are not returned. `user_id` and `organization_id` are taken from the bearer token when it carries them.
|
|
275
354
|
parameters:
|
|
276
355
|
- $ref: '#/components/parameters/workflowID'
|
|
277
356
|
- $ref: '#/components/parameters/status'
|
|
278
357
|
- $ref: '#/components/parameters/offset'
|
|
279
358
|
- $ref: '#/components/parameters/limit'
|
|
359
|
+
- $ref: '#/components/parameters/user_id'
|
|
360
|
+
- $ref: '#/components/parameters/organization_id'
|
|
361
|
+
- $ref: '#/components/parameters/q'
|
|
362
|
+
- $ref: '#/components/parameters/sort'
|
|
363
|
+
- $ref: '#/components/parameters/show_org_workflow_instances'
|
|
364
|
+
- $ref: '#/components/parameters/start_time'
|
|
365
|
+
- $ref: '#/components/parameters/stop_time'
|
|
366
|
+
- $ref: '#/components/parameters/embed'
|
|
280
367
|
responses:
|
|
281
368
|
'200':
|
|
282
369
|
description: OK - Successful response
|
|
@@ -284,26 +371,22 @@ paths:
|
|
|
284
371
|
application/json:
|
|
285
372
|
schema:
|
|
286
373
|
$ref: '#/components/schemas/200-WorkflowInstances'
|
|
374
|
+
'401':
|
|
375
|
+
$ref: '#/components/responses/Unauthorized'
|
|
287
376
|
'403':
|
|
288
|
-
|
|
289
|
-
'
|
|
290
|
-
|
|
377
|
+
$ref: '#/components/responses/Forbidden'
|
|
378
|
+
'422':
|
|
379
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
291
380
|
tags:
|
|
292
381
|
- workflow_instances
|
|
293
382
|
/workflow_instances/{id}:
|
|
294
383
|
get:
|
|
295
384
|
operationId: getWorkflowInstance
|
|
296
385
|
summary: Get a job
|
|
297
|
-
description: Returns a job with a unique ID.
|
|
386
|
+
description: Returns a job with a unique ID. Requires the administrator scope, or the `manage_jobs` or `edit` permission on the workflow.
|
|
298
387
|
parameters:
|
|
299
|
-
-
|
|
300
|
-
|
|
301
|
-
description: Numeric ID of the job to get
|
|
302
|
-
required: true
|
|
303
|
-
schema:
|
|
304
|
-
type: string
|
|
305
|
-
examples:
|
|
306
|
-
- '8588'
|
|
388
|
+
- $ref: '#/components/parameters/instanceIdPath'
|
|
389
|
+
- $ref: '#/components/parameters/embed'
|
|
307
390
|
responses:
|
|
308
391
|
'200':
|
|
309
392
|
description: OK - Successful response
|
|
@@ -311,41 +394,37 @@ paths:
|
|
|
311
394
|
application/json:
|
|
312
395
|
schema:
|
|
313
396
|
$ref: '#/components/schemas/WorkflowInstances'
|
|
397
|
+
'401':
|
|
398
|
+
$ref: '#/components/responses/Unauthorized'
|
|
314
399
|
'403':
|
|
315
|
-
|
|
316
|
-
'
|
|
317
|
-
|
|
400
|
+
$ref: '#/components/responses/Forbidden'
|
|
401
|
+
'404':
|
|
402
|
+
$ref: '#/components/responses/NotFound'
|
|
318
403
|
tags:
|
|
319
404
|
- workflow_instances
|
|
320
405
|
delete:
|
|
321
406
|
operationId: deleteWorkflowInstance
|
|
322
407
|
summary: Delete a job
|
|
323
|
-
description:
|
|
408
|
+
description: Deletes a job with a unique ID. Requires the administrator scope, or the `manage_jobs` or `edit` permission on the workflow.
|
|
324
409
|
parameters:
|
|
325
|
-
-
|
|
326
|
-
in: path
|
|
327
|
-
description: Numeric ID of the job to delete
|
|
328
|
-
required: true
|
|
329
|
-
schema:
|
|
330
|
-
type: string
|
|
410
|
+
- $ref: '#/components/parameters/instanceIdPath'
|
|
331
411
|
responses:
|
|
332
412
|
'204':
|
|
333
413
|
description: No Content
|
|
414
|
+
'401':
|
|
415
|
+
$ref: '#/components/responses/Unauthorized'
|
|
334
416
|
'403':
|
|
335
|
-
|
|
417
|
+
$ref: '#/components/responses/Forbidden'
|
|
418
|
+
'404':
|
|
419
|
+
$ref: '#/components/responses/NotFound'
|
|
336
420
|
tags:
|
|
337
421
|
- workflow_instances
|
|
338
422
|
put:
|
|
339
423
|
operationId: cancelWorkflowInstance
|
|
340
424
|
summary: Cancel a job
|
|
341
|
-
description:
|
|
425
|
+
description: Sets the status of a job with a unique ID. To cancel a running job, send `canceled`; doing so allows you to edit the workflow that generated the job. Requires the administrator scope, or the `manage_jobs` or `edit` permission on the workflow.
|
|
342
426
|
parameters:
|
|
343
|
-
-
|
|
344
|
-
in: path
|
|
345
|
-
description: Numeric ID of the job to cancel
|
|
346
|
-
required: true
|
|
347
|
-
schema:
|
|
348
|
-
type: string
|
|
427
|
+
- $ref: '#/components/parameters/instanceIdPath'
|
|
349
428
|
requestBody:
|
|
350
429
|
required: true
|
|
351
430
|
content:
|
|
@@ -355,15 +434,21 @@ paths:
|
|
|
355
434
|
responses:
|
|
356
435
|
'204':
|
|
357
436
|
description: No Content
|
|
437
|
+
'401':
|
|
438
|
+
$ref: '#/components/responses/Unauthorized'
|
|
358
439
|
'403':
|
|
359
|
-
|
|
440
|
+
$ref: '#/components/responses/Forbidden'
|
|
441
|
+
'404':
|
|
442
|
+
$ref: '#/components/responses/NotFound'
|
|
443
|
+
'422':
|
|
444
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
360
445
|
tags:
|
|
361
446
|
- workflow_instances
|
|
362
447
|
/steps:
|
|
363
448
|
post:
|
|
364
449
|
operationId: createStep
|
|
365
450
|
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
|
|
451
|
+
description: Creates a step in the workflow. The step is not part of the workflow until its ID is added to the workflow `step_order` with a PUT /workflows/{id} request; the API refuses to create an action in a step that is not in `step_order`. Each step can hold one or more actions, which you create with POST /actions after that. Requires the `edit` permission on the workflow.
|
|
367
452
|
requestBody:
|
|
368
453
|
required: true
|
|
369
454
|
content:
|
|
@@ -379,26 +464,23 @@ paths:
|
|
|
379
464
|
$ref: '#/components/schemas/201-Step'
|
|
380
465
|
'400':
|
|
381
466
|
description: Bad Request. The payload may not be in the correct format (JSON format).
|
|
467
|
+
'401':
|
|
468
|
+
$ref: '#/components/responses/Unauthorized'
|
|
382
469
|
'403':
|
|
383
|
-
|
|
470
|
+
$ref: '#/components/responses/Forbidden'
|
|
471
|
+
'404':
|
|
472
|
+
$ref: '#/components/responses/NotFound'
|
|
384
473
|
'422':
|
|
385
|
-
|
|
474
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
386
475
|
tags:
|
|
387
476
|
- steps
|
|
388
477
|
/steps/{id}:
|
|
389
478
|
get:
|
|
390
479
|
operationId: getStep
|
|
391
480
|
summary: Get a step
|
|
392
|
-
description: Returns the data for a step with a unique ID,
|
|
481
|
+
description: Returns the data for a step with a unique ID, with its actions. A deleted step returns 404.
|
|
393
482
|
parameters:
|
|
394
|
-
-
|
|
395
|
-
in: path
|
|
396
|
-
description: Numeric ID of the step to get
|
|
397
|
-
required: true
|
|
398
|
-
schema:
|
|
399
|
-
type: string
|
|
400
|
-
examples:
|
|
401
|
-
- '1076'
|
|
483
|
+
- $ref: '#/components/parameters/stepIdPath'
|
|
402
484
|
responses:
|
|
403
485
|
'200':
|
|
404
486
|
description: OK - Successful response
|
|
@@ -406,102 +488,137 @@ paths:
|
|
|
406
488
|
application/json:
|
|
407
489
|
schema:
|
|
408
490
|
$ref: '#/components/schemas/200-StepsID'
|
|
491
|
+
'401':
|
|
492
|
+
$ref: '#/components/responses/Unauthorized'
|
|
409
493
|
'403':
|
|
410
|
-
|
|
411
|
-
'
|
|
412
|
-
|
|
494
|
+
$ref: '#/components/responses/Forbidden'
|
|
495
|
+
'404':
|
|
496
|
+
$ref: '#/components/responses/NotFound'
|
|
413
497
|
tags:
|
|
414
498
|
- steps
|
|
415
499
|
put:
|
|
416
500
|
operationId: updateStep
|
|
417
501
|
summary: Update a step
|
|
418
|
-
description:
|
|
502
|
+
description: Edits the details of a step with a unique ID. Requires the `edit` permission on the workflow.
|
|
419
503
|
parameters:
|
|
420
|
-
-
|
|
421
|
-
in: path
|
|
422
|
-
description: Numeric ID of the step to update
|
|
423
|
-
required: true
|
|
424
|
-
schema:
|
|
425
|
-
type: string
|
|
504
|
+
- $ref: '#/components/parameters/stepIdPath'
|
|
426
505
|
requestBody:
|
|
427
506
|
required: true
|
|
428
507
|
content:
|
|
429
508
|
application/json:
|
|
430
509
|
schema:
|
|
431
|
-
$ref: '#/components/schemas/
|
|
510
|
+
$ref: '#/components/schemas/updateStepRequest'
|
|
432
511
|
responses:
|
|
433
512
|
'204':
|
|
434
513
|
description: No Content
|
|
435
514
|
'400':
|
|
436
515
|
description: Bad Request. The payload may not be in the correct format (JSON format).
|
|
516
|
+
'401':
|
|
517
|
+
$ref: '#/components/responses/Unauthorized'
|
|
437
518
|
'403':
|
|
438
|
-
|
|
519
|
+
$ref: '#/components/responses/Forbidden'
|
|
520
|
+
'404':
|
|
521
|
+
$ref: '#/components/responses/NotFound'
|
|
439
522
|
'422':
|
|
440
|
-
|
|
523
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
441
524
|
tags:
|
|
442
525
|
- steps
|
|
443
526
|
delete:
|
|
444
527
|
operationId: deleteStep
|
|
445
528
|
summary: Delete a step
|
|
446
|
-
description:
|
|
529
|
+
description: Deletes a step with a unique ID, and its actions. Requires the `edit` permission on the workflow. Fails with 422 while a job of the workflow is executing, initiating or queued.
|
|
447
530
|
parameters:
|
|
448
|
-
-
|
|
449
|
-
in: path
|
|
450
|
-
description: Numeric ID of the step to delete
|
|
451
|
-
required: true
|
|
452
|
-
schema:
|
|
453
|
-
type: string
|
|
531
|
+
- $ref: '#/components/parameters/stepIdPath'
|
|
454
532
|
responses:
|
|
455
533
|
'204':
|
|
456
534
|
description: No Content
|
|
535
|
+
'401':
|
|
536
|
+
$ref: '#/components/responses/Unauthorized'
|
|
457
537
|
'403':
|
|
458
|
-
|
|
538
|
+
$ref: '#/components/responses/Forbidden'
|
|
539
|
+
'404':
|
|
540
|
+
$ref: '#/components/responses/NotFound'
|
|
541
|
+
'422':
|
|
542
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
459
543
|
tags:
|
|
460
544
|
- steps
|
|
461
545
|
/actions:
|
|
462
546
|
post:
|
|
463
547
|
operationId: createAction
|
|
464
548
|
summary: Create an action
|
|
465
|
-
description:
|
|
549
|
+
description: |-
|
|
550
|
+
Creates an action, or a trigger, in a step. The `type` selects the structure of `data`. The step must be in the `step_order` of its workflow. The first step of a workflow contains exactly one action, a trigger (`manual`, `scheduled`, `watch_folder`, `shared_inbox` or `delete_folder`); the other steps contain no trigger. Requires the `edit` permission on the workflow.
|
|
551
|
+
|
|
552
|
+
The `data` is validated strictly: a property that is not listed for the type is rejected. Sensitive values (tokens, passwords, credentials) are not returned in the response.
|
|
466
553
|
requestBody:
|
|
467
554
|
required: true
|
|
468
555
|
content:
|
|
469
556
|
application/json:
|
|
470
557
|
schema:
|
|
471
|
-
|
|
472
|
-
- $ref: '#/components/schemas/createActionTransfer'
|
|
473
|
-
- $ref: '#/components/schemas/createActionAPI'
|
|
558
|
+
$ref: '#/components/schemas/createAction'
|
|
474
559
|
responses:
|
|
475
560
|
'201':
|
|
476
561
|
description: Successfully created
|
|
477
562
|
content:
|
|
478
563
|
application/json:
|
|
479
564
|
schema:
|
|
480
|
-
|
|
481
|
-
- $ref: '#/components/schemas/201-ActionTransfer'
|
|
482
|
-
- $ref: '#/components/schemas/201-ActionAPI'
|
|
565
|
+
$ref: '#/components/schemas/actionData'
|
|
483
566
|
'400':
|
|
484
567
|
description: Bad Request. The payload may not be in the correct format (JSON format).
|
|
568
|
+
'401':
|
|
569
|
+
$ref: '#/components/responses/Unauthorized'
|
|
570
|
+
'403':
|
|
571
|
+
$ref: '#/components/responses/Forbidden'
|
|
572
|
+
'404':
|
|
573
|
+
$ref: '#/components/responses/NotFound'
|
|
574
|
+
'422':
|
|
575
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
576
|
+
tags:
|
|
577
|
+
- actions
|
|
578
|
+
/actions/validate:
|
|
579
|
+
post:
|
|
580
|
+
operationId: validateActionCredentials
|
|
581
|
+
summary: Validate the credentials of a node
|
|
582
|
+
description: Checks the `authentication` of the `source` and of the `destination` of a `transfer` action against the node. Only `transfer` is supported. Returns 422 if neither location has an `authentication`.
|
|
583
|
+
requestBody:
|
|
584
|
+
required: true
|
|
585
|
+
content:
|
|
586
|
+
application/json:
|
|
587
|
+
schema:
|
|
588
|
+
type: object
|
|
589
|
+
properties:
|
|
590
|
+
type:
|
|
591
|
+
type: string
|
|
592
|
+
enum:
|
|
593
|
+
- transfer
|
|
594
|
+
source:
|
|
595
|
+
$ref: '#/components/schemas/TransferSource'
|
|
596
|
+
destination:
|
|
597
|
+
$ref: '#/components/schemas/TransferDestination'
|
|
598
|
+
required:
|
|
599
|
+
- type
|
|
600
|
+
responses:
|
|
601
|
+
'200':
|
|
602
|
+
description: Result of the validation, for each location that has an `authentication`.
|
|
603
|
+
content:
|
|
604
|
+
application/json:
|
|
605
|
+
schema:
|
|
606
|
+
$ref: '#/components/schemas/ValidateActionResponse'
|
|
607
|
+
'401':
|
|
608
|
+
$ref: '#/components/responses/Unauthorized'
|
|
485
609
|
'403':
|
|
486
|
-
|
|
610
|
+
$ref: '#/components/responses/Forbidden'
|
|
487
611
|
'422':
|
|
488
|
-
|
|
612
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
489
613
|
tags:
|
|
490
614
|
- actions
|
|
491
615
|
/actions/{id}:
|
|
492
616
|
get:
|
|
493
617
|
operationId: getAction
|
|
494
618
|
summary: Get an action
|
|
495
|
-
description: Returns data for an action with a unique ID.
|
|
619
|
+
description: Returns data for an action with a unique ID. A deleted action returns 404.
|
|
496
620
|
parameters:
|
|
497
|
-
-
|
|
498
|
-
in: path
|
|
499
|
-
description: Numeric ID of the action to get
|
|
500
|
-
required: true
|
|
501
|
-
schema:
|
|
502
|
-
type: string
|
|
503
|
-
examples:
|
|
504
|
-
- '1076'
|
|
621
|
+
- $ref: '#/components/parameters/actionIdPath'
|
|
505
622
|
responses:
|
|
506
623
|
'200':
|
|
507
624
|
description: OK - Successful response
|
|
@@ -509,84 +626,91 @@ paths:
|
|
|
509
626
|
application/json:
|
|
510
627
|
schema:
|
|
511
628
|
$ref: '#/components/schemas/actionData'
|
|
629
|
+
'401':
|
|
630
|
+
$ref: '#/components/responses/Unauthorized'
|
|
512
631
|
'403':
|
|
513
|
-
|
|
514
|
-
'
|
|
515
|
-
|
|
632
|
+
$ref: '#/components/responses/Forbidden'
|
|
633
|
+
'404':
|
|
634
|
+
$ref: '#/components/responses/NotFound'
|
|
516
635
|
tags:
|
|
517
636
|
- actions
|
|
518
637
|
put:
|
|
519
638
|
operationId: updateAction
|
|
520
639
|
summary: Update an action
|
|
521
|
-
description:
|
|
640
|
+
description: Edits the values of an action with a unique ID. The `type` is required, because it selects the allowed properties of `data`. Requires the `edit` permission on the workflow.
|
|
522
641
|
parameters:
|
|
523
|
-
-
|
|
524
|
-
in: path
|
|
525
|
-
description: Numeric ID of the action to update
|
|
526
|
-
required: true
|
|
527
|
-
schema:
|
|
528
|
-
type: string
|
|
642
|
+
- $ref: '#/components/parameters/actionIdPath'
|
|
529
643
|
requestBody:
|
|
530
644
|
required: true
|
|
531
645
|
content:
|
|
532
646
|
application/json:
|
|
533
647
|
schema:
|
|
534
|
-
|
|
535
|
-
- $ref: '#/components/schemas/createActionTransfer'
|
|
536
|
-
- $ref: '#/components/schemas/createActionAPI'
|
|
648
|
+
$ref: '#/components/schemas/createAction'
|
|
537
649
|
responses:
|
|
538
650
|
'204':
|
|
539
651
|
description: No Content
|
|
540
652
|
'400':
|
|
541
653
|
description: Bad Request. The payload may not be in the correct format (JSON format).
|
|
654
|
+
'401':
|
|
655
|
+
$ref: '#/components/responses/Unauthorized'
|
|
542
656
|
'403':
|
|
543
|
-
|
|
657
|
+
$ref: '#/components/responses/Forbidden'
|
|
658
|
+
'404':
|
|
659
|
+
$ref: '#/components/responses/NotFound'
|
|
544
660
|
'422':
|
|
545
|
-
|
|
661
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
546
662
|
tags:
|
|
547
663
|
- actions
|
|
548
664
|
delete:
|
|
549
665
|
operationId: deleteAction
|
|
550
666
|
summary: Delete an action
|
|
551
|
-
description:
|
|
667
|
+
description: Deletes an action with a unique ID. Requires the `edit` permission on the workflow. Fails with 422 while a job of the workflow is executing, initiating or queued.
|
|
552
668
|
parameters:
|
|
553
|
-
-
|
|
554
|
-
in: path
|
|
555
|
-
description: Numeric ID of the action to delete
|
|
556
|
-
required: true
|
|
557
|
-
schema:
|
|
558
|
-
type: string
|
|
669
|
+
- $ref: '#/components/parameters/actionIdPath'
|
|
559
670
|
responses:
|
|
560
671
|
'204':
|
|
561
672
|
description: No Content
|
|
673
|
+
'401':
|
|
674
|
+
$ref: '#/components/responses/Unauthorized'
|
|
562
675
|
'403':
|
|
563
|
-
|
|
676
|
+
$ref: '#/components/responses/Forbidden'
|
|
677
|
+
'404':
|
|
678
|
+
$ref: '#/components/responses/NotFound'
|
|
679
|
+
'422':
|
|
680
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
564
681
|
tags:
|
|
565
682
|
- actions
|
|
566
683
|
/workflow_permissions:
|
|
567
684
|
get:
|
|
568
685
|
operationId: listWorkflowPermissions
|
|
569
686
|
summary: Get workflow permissions
|
|
570
|
-
description: Returns
|
|
687
|
+
description: Returns the permissions of a workflow, as an array. Requires a permission on the workflow, or the administrator scope.
|
|
571
688
|
parameters:
|
|
572
689
|
- $ref: '#/components/parameters/workflow_ID'
|
|
690
|
+
- $ref: '#/components/parameters/user_id'
|
|
573
691
|
responses:
|
|
574
692
|
'200':
|
|
575
693
|
description: OK - Successful response
|
|
576
694
|
content:
|
|
577
695
|
application/json:
|
|
578
696
|
schema:
|
|
579
|
-
|
|
697
|
+
type: array
|
|
698
|
+
items:
|
|
699
|
+
$ref: '#/components/schemas/WorkflowPermissions'
|
|
700
|
+
'401':
|
|
701
|
+
$ref: '#/components/responses/Unauthorized'
|
|
580
702
|
'403':
|
|
581
|
-
|
|
582
|
-
'
|
|
583
|
-
|
|
703
|
+
$ref: '#/components/responses/Forbidden'
|
|
704
|
+
'404':
|
|
705
|
+
$ref: '#/components/responses/NotFound'
|
|
706
|
+
'422':
|
|
707
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
584
708
|
tags:
|
|
585
709
|
- workflow_permissions
|
|
586
710
|
post:
|
|
587
711
|
operationId: createWorkflowPermission
|
|
588
712
|
summary: Create a workflow permission
|
|
589
|
-
description:
|
|
713
|
+
description: Shares a workflow with a user. At least one of `edit`, `manage_jobs` and `duplicate` must be true, and a user has one permission per workflow. The user receives a notification. Requires the `edit` permission on the workflow.
|
|
590
714
|
requestBody:
|
|
591
715
|
required: true
|
|
592
716
|
content:
|
|
@@ -602,24 +726,23 @@ paths:
|
|
|
602
726
|
$ref: '#/components/schemas/WorkflowPermissions'
|
|
603
727
|
'400':
|
|
604
728
|
description: Bad Request. The payload may not be in the correct format (JSON format).
|
|
729
|
+
'401':
|
|
730
|
+
$ref: '#/components/responses/Unauthorized'
|
|
605
731
|
'403':
|
|
606
|
-
|
|
732
|
+
$ref: '#/components/responses/Forbidden'
|
|
733
|
+
'404':
|
|
734
|
+
$ref: '#/components/responses/NotFound'
|
|
607
735
|
'422':
|
|
608
|
-
|
|
736
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
609
737
|
tags:
|
|
610
738
|
- workflow_permissions
|
|
611
739
|
/workflow_permissions/{id}:
|
|
612
740
|
put:
|
|
613
741
|
operationId: updateWorkflowPermission
|
|
614
742
|
summary: Update a workflow permission
|
|
615
|
-
description:
|
|
743
|
+
description: Edits a workflow permission with a unique ID. The permission of the owner of the workflow cannot be edited (422). Requires the `edit` permission on the workflow.
|
|
616
744
|
parameters:
|
|
617
|
-
-
|
|
618
|
-
in: path
|
|
619
|
-
description: Numeric ID of the workflow permission
|
|
620
|
-
required: true
|
|
621
|
-
schema:
|
|
622
|
-
type: string
|
|
745
|
+
- $ref: '#/components/parameters/permissionIdPath'
|
|
623
746
|
requestBody:
|
|
624
747
|
required: true
|
|
625
748
|
content:
|
|
@@ -631,44 +754,166 @@ paths:
|
|
|
631
754
|
description: No Content
|
|
632
755
|
'400':
|
|
633
756
|
description: Bad Request. The payload may not be in the correct format (JSON format).
|
|
757
|
+
'401':
|
|
758
|
+
$ref: '#/components/responses/Unauthorized'
|
|
634
759
|
'403':
|
|
635
|
-
|
|
760
|
+
$ref: '#/components/responses/Forbidden'
|
|
761
|
+
'404':
|
|
762
|
+
$ref: '#/components/responses/NotFound'
|
|
636
763
|
'422':
|
|
637
|
-
|
|
764
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
638
765
|
tags:
|
|
639
766
|
- workflow_permissions
|
|
640
767
|
delete:
|
|
641
768
|
operationId: deleteWorkflowPermission
|
|
642
769
|
summary: Delete a workflow permission
|
|
643
|
-
description:
|
|
770
|
+
description: Deletes a workflow permission with a unique ID. The permission of the owner of the workflow cannot be deleted (422). Requires the `edit` permission on the workflow.
|
|
644
771
|
parameters:
|
|
645
|
-
-
|
|
646
|
-
in: path
|
|
647
|
-
description: Numeric ID of the workflow permission to delete
|
|
648
|
-
required: true
|
|
649
|
-
schema:
|
|
650
|
-
type: string
|
|
772
|
+
- $ref: '#/components/parameters/permissionIdPath'
|
|
651
773
|
responses:
|
|
652
774
|
'204':
|
|
653
775
|
description: No Content
|
|
776
|
+
'401':
|
|
777
|
+
$ref: '#/components/responses/Unauthorized'
|
|
654
778
|
'403':
|
|
655
|
-
|
|
779
|
+
$ref: '#/components/responses/Forbidden'
|
|
780
|
+
'404':
|
|
781
|
+
$ref: '#/components/responses/NotFound'
|
|
782
|
+
'422':
|
|
783
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
656
784
|
tags:
|
|
657
785
|
- workflow_permissions
|
|
786
|
+
/app_permissions/{id}:
|
|
787
|
+
get:
|
|
788
|
+
operationId: getAppPermissions
|
|
789
|
+
summary: Get automation application permissions
|
|
790
|
+
description: Returns the configuration settings of the Automation application for the organization. The `id` must be the organization of the bearer token.
|
|
791
|
+
parameters:
|
|
792
|
+
- $ref: '#/components/parameters/organizationIdPath'
|
|
793
|
+
responses:
|
|
794
|
+
'200':
|
|
795
|
+
description: OK - Successful response
|
|
796
|
+
content:
|
|
797
|
+
application/json:
|
|
798
|
+
schema:
|
|
799
|
+
$ref: '#/components/schemas/AppPermissions'
|
|
800
|
+
'401':
|
|
801
|
+
$ref: '#/components/responses/Unauthorized'
|
|
802
|
+
'403':
|
|
803
|
+
$ref: '#/components/responses/Forbidden'
|
|
804
|
+
'404':
|
|
805
|
+
$ref: '#/components/responses/NotFound'
|
|
806
|
+
tags:
|
|
807
|
+
- app_permissions
|
|
808
|
+
put:
|
|
809
|
+
operationId: updateAppPermissions
|
|
810
|
+
summary: Update automation application permissions
|
|
811
|
+
description: Updates the configuration settings of the Automation application for the organization. Requires the administrator scope; the `id` must be the organization of the bearer token.
|
|
812
|
+
parameters:
|
|
813
|
+
- $ref: '#/components/parameters/organizationIdPath'
|
|
814
|
+
requestBody:
|
|
815
|
+
required: true
|
|
816
|
+
content:
|
|
817
|
+
application/json:
|
|
818
|
+
schema:
|
|
819
|
+
$ref: '#/components/schemas/updateAppPermissionsRequest'
|
|
820
|
+
responses:
|
|
821
|
+
'204':
|
|
822
|
+
description: No Content
|
|
823
|
+
'400':
|
|
824
|
+
description: Bad Request. The payload may not be in the correct format (JSON format).
|
|
825
|
+
'401':
|
|
826
|
+
$ref: '#/components/responses/Unauthorized'
|
|
827
|
+
'403':
|
|
828
|
+
$ref: '#/components/responses/Forbidden'
|
|
829
|
+
'404':
|
|
830
|
+
$ref: '#/components/responses/NotFound'
|
|
831
|
+
'422':
|
|
832
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
833
|
+
tags:
|
|
834
|
+
- app_permissions
|
|
835
|
+
/external/api_callback:
|
|
836
|
+
post:
|
|
837
|
+
operationId: apiCallback
|
|
838
|
+
summary: Report the progress or the result of an API action
|
|
839
|
+
description: 'Called by the service reached by an `api` action with `callback: true`. The request is not authenticated: the `token` that Automation injected in the payload identifies the action. The service sends `in_progress` notifications, then a final `success` or `failed`. The body is forwarded as is to the workflow engine.'
|
|
840
|
+
security: []
|
|
841
|
+
requestBody:
|
|
842
|
+
required: true
|
|
843
|
+
content:
|
|
844
|
+
application/json:
|
|
845
|
+
schema:
|
|
846
|
+
$ref: '#/components/schemas/ApiCallbackRequest'
|
|
847
|
+
responses:
|
|
848
|
+
'200':
|
|
849
|
+
description: The callback was accepted.
|
|
850
|
+
'422':
|
|
851
|
+
$ref: '#/components/responses/UnprocessableEntity'
|
|
852
|
+
'500':
|
|
853
|
+
description: Internal Server Error
|
|
854
|
+
tags:
|
|
855
|
+
- external
|
|
856
|
+
/external/telestream:
|
|
857
|
+
post:
|
|
858
|
+
operationId: telestreamCallback
|
|
859
|
+
summary: Report the result of a Telestream quality control
|
|
860
|
+
description: Called by the Telestream service for a `telestream_qc` action. The request is not authenticated. The body is forwarded as is to the workflow engine.
|
|
861
|
+
security: []
|
|
862
|
+
requestBody:
|
|
863
|
+
required: true
|
|
864
|
+
content:
|
|
865
|
+
application/json:
|
|
866
|
+
schema:
|
|
867
|
+
type: object
|
|
868
|
+
additionalProperties: true
|
|
869
|
+
responses:
|
|
870
|
+
'200':
|
|
871
|
+
description: The callback was accepted.
|
|
872
|
+
'500':
|
|
873
|
+
description: Internal Server Error
|
|
874
|
+
tags:
|
|
875
|
+
- external
|
|
876
|
+
/ping:
|
|
877
|
+
get:
|
|
878
|
+
operationId: ping
|
|
879
|
+
summary: Check the service
|
|
880
|
+
description: Checks the database and the message broker. The request is not authenticated.
|
|
881
|
+
security: []
|
|
882
|
+
responses:
|
|
883
|
+
'200':
|
|
884
|
+
description: The database and the broker are reachable.
|
|
885
|
+
content:
|
|
886
|
+
application/json:
|
|
887
|
+
schema:
|
|
888
|
+
$ref: '#/components/schemas/Ping'
|
|
889
|
+
'503':
|
|
890
|
+
description: The database or the broker is not reachable.
|
|
891
|
+
content:
|
|
892
|
+
application/json:
|
|
893
|
+
schema:
|
|
894
|
+
$ref: '#/components/schemas/Ping'
|
|
895
|
+
tags:
|
|
896
|
+
- external
|
|
658
897
|
components:
|
|
659
898
|
parameters:
|
|
660
899
|
status:
|
|
661
900
|
name: status
|
|
662
901
|
in: query
|
|
663
|
-
description: 'Status of the job. Allowed values: executing,
|
|
902
|
+
description: 'Status of the job. Allowed values: initiating, executing, queued, queue_full, paused, resumed, complete, failed, canceled, timeout.'
|
|
664
903
|
required: false
|
|
665
904
|
schema:
|
|
666
905
|
type: string
|
|
667
906
|
enum:
|
|
907
|
+
- initiating
|
|
668
908
|
- executing
|
|
669
|
-
-
|
|
909
|
+
- queued
|
|
910
|
+
- queue_full
|
|
911
|
+
- paused
|
|
912
|
+
- resumed
|
|
670
913
|
- complete
|
|
914
|
+
- failed
|
|
671
915
|
- canceled
|
|
916
|
+
- timeout
|
|
672
917
|
example: executing
|
|
673
918
|
workflow_ID:
|
|
674
919
|
name: workflow_id
|
|
@@ -686,77 +931,259 @@ components:
|
|
|
686
931
|
schema:
|
|
687
932
|
type: string
|
|
688
933
|
example: '362'
|
|
689
|
-
|
|
690
|
-
name:
|
|
934
|
+
response_type:
|
|
935
|
+
name: response_type
|
|
691
936
|
in: query
|
|
692
|
-
description:
|
|
937
|
+
description: Detail level of returned workflows ('long' returns full steps and actions)
|
|
693
938
|
required: false
|
|
694
939
|
schema:
|
|
695
|
-
type:
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
940
|
+
type: string
|
|
941
|
+
enum:
|
|
942
|
+
- short
|
|
943
|
+
- long
|
|
944
|
+
default: short
|
|
945
|
+
example: long
|
|
946
|
+
start_time:
|
|
947
|
+
name: start_time
|
|
700
948
|
in: query
|
|
701
|
-
description:
|
|
949
|
+
description: Start of the time window (ISO 8601) on the job last update time. Ignored unless stop_time is also provided.
|
|
702
950
|
required: false
|
|
703
951
|
schema:
|
|
704
|
-
type:
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
description:
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
952
|
+
type: string
|
|
953
|
+
format: date-time
|
|
954
|
+
example: '2026-11-07T00:00:00Z'
|
|
955
|
+
stop_time:
|
|
956
|
+
name: stop_time
|
|
957
|
+
in: query
|
|
958
|
+
description: End of the time window (ISO 8601) on the job last update time. Ignored unless start_time is also provided.
|
|
959
|
+
required: false
|
|
960
|
+
schema:
|
|
961
|
+
type: string
|
|
962
|
+
format: date-time
|
|
963
|
+
example: '2026-11-09T00:00:00Z'
|
|
964
|
+
show_org_workflow_instances:
|
|
965
|
+
name: show_org_workflow_instances
|
|
966
|
+
in: query
|
|
967
|
+
description: If true and the caller is an administrator, return jobs of all workflows of the organization, else only jobs of workflows on which the user has a permission. Ignored for non-administrators. Not needed if workflow_id is provided.
|
|
968
|
+
required: false
|
|
969
|
+
schema:
|
|
970
|
+
type: boolean
|
|
971
|
+
example: true
|
|
972
|
+
workflowIdPath:
|
|
973
|
+
name: id
|
|
974
|
+
in: path
|
|
975
|
+
description: Numeric ID of the workflow
|
|
976
|
+
required: true
|
|
977
|
+
schema:
|
|
978
|
+
type: string
|
|
979
|
+
example: '1120'
|
|
980
|
+
instanceIdPath:
|
|
981
|
+
name: id
|
|
982
|
+
in: path
|
|
983
|
+
description: Numeric ID of the job, or its `instance_id` (UUID)
|
|
984
|
+
required: true
|
|
985
|
+
schema:
|
|
986
|
+
type: string
|
|
987
|
+
example: '8588'
|
|
988
|
+
stepIdPath:
|
|
989
|
+
name: id
|
|
990
|
+
in: path
|
|
991
|
+
description: Numeric ID of the step
|
|
992
|
+
required: true
|
|
993
|
+
schema:
|
|
994
|
+
type: string
|
|
995
|
+
example: '1076'
|
|
996
|
+
actionIdPath:
|
|
997
|
+
name: id
|
|
998
|
+
in: path
|
|
999
|
+
description: Numeric ID of the action
|
|
1000
|
+
required: true
|
|
1001
|
+
schema:
|
|
1002
|
+
type: string
|
|
1003
|
+
example: '1071'
|
|
1004
|
+
permissionIdPath:
|
|
1005
|
+
name: id
|
|
1006
|
+
in: path
|
|
1007
|
+
description: Numeric ID of the workflow permission
|
|
1008
|
+
required: true
|
|
1009
|
+
schema:
|
|
1010
|
+
type: string
|
|
1011
|
+
example: '26'
|
|
1012
|
+
organizationIdPath:
|
|
1013
|
+
name: id
|
|
1014
|
+
in: path
|
|
1015
|
+
description: Numeric ID of the organization. It must be the organization of the bearer token.
|
|
1016
|
+
required: true
|
|
1017
|
+
schema:
|
|
1018
|
+
type: string
|
|
1019
|
+
example: '58'
|
|
1020
|
+
offset:
|
|
1021
|
+
name: offset
|
|
1022
|
+
in: query
|
|
1023
|
+
description: Number of records to skip (pagination). The first page is offset 0; the second page is offset `limit`.
|
|
1024
|
+
required: false
|
|
1025
|
+
schema:
|
|
1026
|
+
type: integer
|
|
1027
|
+
minimum: 0
|
|
1028
|
+
default: 0
|
|
1029
|
+
limit:
|
|
1030
|
+
name: limit
|
|
1031
|
+
in: query
|
|
1032
|
+
description: Maximum number of records to return. Values above 1000 are reduced to 1000.
|
|
1033
|
+
required: false
|
|
1034
|
+
schema:
|
|
1035
|
+
type: integer
|
|
1036
|
+
minimum: 1
|
|
1037
|
+
maximum: 1000
|
|
1038
|
+
default: 20
|
|
1039
|
+
q:
|
|
1040
|
+
name: q
|
|
1041
|
+
in: query
|
|
1042
|
+
description: Search string. It filters workflows on name, state, status, organization_id, user_id and user_name; it filters jobs on status, status_details, organization_id, user_id, instance_id, workflow_id and workflow name.
|
|
1043
|
+
required: false
|
|
1044
|
+
schema:
|
|
1045
|
+
type: string
|
|
1046
|
+
example: My Workflow
|
|
1047
|
+
sort:
|
|
1048
|
+
name: sort
|
|
1049
|
+
in: query
|
|
1050
|
+
description: Column to sort by (e.g. `state_change_time` for jobs, `name` for workflows). If the value contains `-`, the sort is descending (e.g. `-state_change_time`), else ascending.
|
|
1051
|
+
required: false
|
|
1052
|
+
schema:
|
|
1053
|
+
type: string
|
|
1054
|
+
example: '-state_change_time'
|
|
1055
|
+
embed:
|
|
1056
|
+
name: embed
|
|
1057
|
+
in: query
|
|
1058
|
+
description: Comma-separated list of objects to embed in each job. Allowed values are `workflow` and `step`.
|
|
1059
|
+
required: false
|
|
1060
|
+
schema:
|
|
1061
|
+
type: string
|
|
1062
|
+
example: workflow,step
|
|
1063
|
+
user_id:
|
|
1064
|
+
name: user_id
|
|
1065
|
+
in: query
|
|
1066
|
+
description: User ID. Ignored when the bearer token carries a user ID.
|
|
1067
|
+
required: false
|
|
1068
|
+
schema:
|
|
1069
|
+
type: string
|
|
1070
|
+
example: '1072'
|
|
1071
|
+
organization_id:
|
|
1072
|
+
name: organization_id
|
|
1073
|
+
in: query
|
|
1074
|
+
description: Organization ID. Ignored when the bearer token carries an organization ID; if provided, it must be the organization of the token.
|
|
1075
|
+
required: false
|
|
1076
|
+
schema:
|
|
1077
|
+
type: string
|
|
1078
|
+
example: '58'
|
|
1079
|
+
show_org_workflows:
|
|
1080
|
+
name: show_org_workflows
|
|
1081
|
+
in: query
|
|
1082
|
+
description: If true and the caller is an administrator, return all the non-hidden workflows of the organization, else only those on which the user has a permission. Must be `true` or `false`.
|
|
1083
|
+
required: false
|
|
1084
|
+
schema:
|
|
1085
|
+
type: boolean
|
|
1086
|
+
example: true
|
|
1087
|
+
schemas:
|
|
1088
|
+
Error:
|
|
1089
|
+
description: Error returned by the API
|
|
1090
|
+
type: object
|
|
1091
|
+
properties:
|
|
1092
|
+
message:
|
|
1093
|
+
description: The error message
|
|
1094
|
+
type: string
|
|
1095
|
+
examples:
|
|
1096
|
+
- No permission on the resource you are trying to access
|
|
1097
|
+
request_id:
|
|
1098
|
+
description: ID of the request, for support
|
|
1099
|
+
type: string
|
|
1100
|
+
required:
|
|
1101
|
+
- message
|
|
1102
|
+
Pagination:
|
|
1103
|
+
description: Properties shared by the lists
|
|
1104
|
+
type: object
|
|
1105
|
+
properties:
|
|
1106
|
+
total_count:
|
|
1107
|
+
description: Number of records that match the request
|
|
1108
|
+
type: integer
|
|
1109
|
+
examples:
|
|
1110
|
+
- 6
|
|
1111
|
+
offset:
|
|
1112
|
+
description: Number of records skipped
|
|
1113
|
+
type: integer
|
|
1114
|
+
examples:
|
|
1115
|
+
- 0
|
|
1116
|
+
limit:
|
|
1117
|
+
description: Maximum number of records returned
|
|
1118
|
+
type: integer
|
|
1119
|
+
examples:
|
|
1120
|
+
- 20
|
|
1121
|
+
first:
|
|
1122
|
+
description: The link for the first page of results
|
|
1123
|
+
type: object
|
|
1124
|
+
properties:
|
|
1125
|
+
href:
|
|
1126
|
+
type: string
|
|
1127
|
+
format: uri
|
|
734
1128
|
last:
|
|
735
1129
|
description: The link for the last page of results
|
|
736
1130
|
type: object
|
|
737
1131
|
properties:
|
|
738
1132
|
href:
|
|
739
|
-
description: URL for the last page of results
|
|
740
1133
|
type: string
|
|
741
1134
|
format: uri
|
|
742
|
-
examples:
|
|
743
|
-
- http://api.qa.ibmaspera.com/automation/v1/workflow_instances?limit=20&offset=20
|
|
744
1135
|
next:
|
|
745
|
-
description: The link for the
|
|
1136
|
+
description: The link for the next page of results. Absent on the last page.
|
|
746
1137
|
type: object
|
|
747
1138
|
properties:
|
|
748
1139
|
href:
|
|
749
|
-
description: URL for the second page of results
|
|
750
1140
|
type: string
|
|
751
1141
|
format: uri
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
1142
|
+
previous:
|
|
1143
|
+
description: The link for the previous page of results. Absent on the first page.
|
|
1144
|
+
type: object
|
|
1145
|
+
properties:
|
|
1146
|
+
href:
|
|
1147
|
+
type: string
|
|
1148
|
+
format: uri
|
|
1149
|
+
200-WorkflowInstances:
|
|
1150
|
+
description: Returned data for the list of jobs
|
|
1151
|
+
title: Success response
|
|
1152
|
+
allOf:
|
|
1153
|
+
- $ref: '#/components/schemas/Pagination'
|
|
1154
|
+
- type: object
|
|
1155
|
+
properties:
|
|
1156
|
+
workflow_instances:
|
|
1157
|
+
description: Array of jobs
|
|
1158
|
+
type: array
|
|
1159
|
+
items:
|
|
1160
|
+
$ref: '#/components/schemas/WorkflowInstances'
|
|
1161
|
+
200-Workflows:
|
|
1162
|
+
description: Returned data for the list of workflows
|
|
759
1163
|
title: Success response
|
|
1164
|
+
allOf:
|
|
1165
|
+
- $ref: '#/components/schemas/Pagination'
|
|
1166
|
+
- type: object
|
|
1167
|
+
properties:
|
|
1168
|
+
workflows:
|
|
1169
|
+
type: array
|
|
1170
|
+
items:
|
|
1171
|
+
$ref: '#/components/schemas/workflowData'
|
|
1172
|
+
JobStatus:
|
|
1173
|
+
description: Status of a job
|
|
1174
|
+
type: string
|
|
1175
|
+
enum:
|
|
1176
|
+
- initiating
|
|
1177
|
+
- executing
|
|
1178
|
+
- queued
|
|
1179
|
+
- queue_full
|
|
1180
|
+
- paused
|
|
1181
|
+
- resumed
|
|
1182
|
+
- complete
|
|
1183
|
+
- failed
|
|
1184
|
+
- canceled
|
|
1185
|
+
- timeout
|
|
1186
|
+
- deleted
|
|
760
1187
|
WorkflowInstances:
|
|
761
1188
|
description: Job data
|
|
762
1189
|
type: object
|
|
@@ -768,11 +1195,13 @@ components:
|
|
|
768
1195
|
- '8588'
|
|
769
1196
|
workflow_version_id:
|
|
770
1197
|
description: ID for the workflow version that is used in generating this workflow instance
|
|
771
|
-
type:
|
|
1198
|
+
type:
|
|
1199
|
+
- string
|
|
1200
|
+
- 'null'
|
|
772
1201
|
examples:
|
|
773
1202
|
- '8588'
|
|
774
1203
|
instance_id:
|
|
775
|
-
description: UUID. Can be used for debugging purposes.
|
|
1204
|
+
description: UUID. Can be used for debugging purposes, and in place of `id` in the path.
|
|
776
1205
|
type: string
|
|
777
1206
|
examples:
|
|
778
1207
|
- f5d74b9c-e2de-4782-9a44-e65b4857d98b
|
|
@@ -782,7 +1211,7 @@ components:
|
|
|
782
1211
|
examples:
|
|
783
1212
|
- '58'
|
|
784
1213
|
user_id:
|
|
785
|
-
description: User ID of
|
|
1214
|
+
description: User ID of the owner of the workflow
|
|
786
1215
|
type: string
|
|
787
1216
|
examples:
|
|
788
1217
|
- '3201'
|
|
@@ -792,7 +1221,7 @@ components:
|
|
|
792
1221
|
examples:
|
|
793
1222
|
- '699'
|
|
794
1223
|
step_id:
|
|
795
|
-
description: ID of
|
|
1224
|
+
description: ID of the step currently executed
|
|
796
1225
|
type: string
|
|
797
1226
|
examples:
|
|
798
1227
|
- '1290'
|
|
@@ -801,16 +1230,18 @@ components:
|
|
|
801
1230
|
type: string
|
|
802
1231
|
examples:
|
|
803
1232
|
- transfer step
|
|
1233
|
+
action_id:
|
|
1234
|
+
description: ID of current action in the workflow instance
|
|
1235
|
+
type: string
|
|
1236
|
+
examples:
|
|
1237
|
+
- '1406'
|
|
804
1238
|
status:
|
|
805
|
-
|
|
1239
|
+
$ref: '#/components/schemas/JobStatus'
|
|
1240
|
+
current_status:
|
|
1241
|
+
description: Human-readable current status description
|
|
806
1242
|
type: string
|
|
807
1243
|
examples:
|
|
808
|
-
-
|
|
809
|
-
enum:
|
|
810
|
-
- executing
|
|
811
|
-
- failed
|
|
812
|
-
- complete
|
|
813
|
-
- canceled
|
|
1244
|
+
- Transfer in progress
|
|
814
1245
|
status_details:
|
|
815
1246
|
description: Error message - only returned for a failed workflow instance
|
|
816
1247
|
type: string
|
|
@@ -828,22 +1259,79 @@ components:
|
|
|
828
1259
|
format: date-time
|
|
829
1260
|
examples:
|
|
830
1261
|
- 2019-03-17T07:07:22.000Z
|
|
1262
|
+
queue_position:
|
|
1263
|
+
description: Position in queue when job is queued
|
|
1264
|
+
type: integer
|
|
1265
|
+
examples:
|
|
1266
|
+
- 1
|
|
831
1267
|
workflow_name:
|
|
832
1268
|
description: Name of the workflow
|
|
833
1269
|
type: string
|
|
834
1270
|
examples:
|
|
835
1271
|
- media content
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
1272
|
+
workflow_trigger_type:
|
|
1273
|
+
description: Type of the trigger of the workflow. Null if the workflow has no trigger.
|
|
1274
|
+
type:
|
|
1275
|
+
- string
|
|
1276
|
+
- 'null'
|
|
1277
|
+
enum:
|
|
1278
|
+
- manual
|
|
1279
|
+
- scheduled
|
|
1280
|
+
- watch_folder
|
|
1281
|
+
- shared_inbox
|
|
1282
|
+
- delete_folder
|
|
1283
|
+
- null
|
|
1284
|
+
workflow:
|
|
1285
|
+
description: The workflow. Present only if `embed` contains `workflow`.
|
|
1286
|
+
type: object
|
|
1287
|
+
step:
|
|
1288
|
+
description: The current step. Present only if `embed` contains `step`.
|
|
1289
|
+
type:
|
|
1290
|
+
- object
|
|
1291
|
+
- 'null'
|
|
1292
|
+
action_statuses:
|
|
1293
|
+
description: Status breakdown per step and action
|
|
1294
|
+
type: object
|
|
1295
|
+
properties:
|
|
1296
|
+
steps:
|
|
1297
|
+
type: array
|
|
1298
|
+
items:
|
|
1299
|
+
type: object
|
|
1300
|
+
properties:
|
|
1301
|
+
id:
|
|
1302
|
+
type: string
|
|
1303
|
+
actions:
|
|
1304
|
+
type: array
|
|
1305
|
+
items:
|
|
1306
|
+
type: object
|
|
1307
|
+
properties:
|
|
1308
|
+
id:
|
|
1309
|
+
type: string
|
|
1310
|
+
status:
|
|
1311
|
+
type: string
|
|
1312
|
+
enum:
|
|
1313
|
+
- initiating
|
|
1314
|
+
- executing
|
|
1315
|
+
- queued
|
|
1316
|
+
- paused
|
|
1317
|
+
- complete
|
|
1318
|
+
- failed
|
|
1319
|
+
outputs:
|
|
1320
|
+
description: Output data of the action
|
|
1321
|
+
type:
|
|
1322
|
+
- object
|
|
1323
|
+
- 'null'
|
|
1324
|
+
additionalProperties: true
|
|
1325
|
+
name:
|
|
1326
|
+
type:
|
|
1327
|
+
- string
|
|
1328
|
+
- 'null'
|
|
1329
|
+
type:
|
|
1330
|
+
type:
|
|
1331
|
+
- string
|
|
1332
|
+
- 'null'
|
|
846
1333
|
WorkflowPermissions:
|
|
1334
|
+
description: A permission of a user on a workflow. The `edit` permission is accepted in the requests but is not returned.
|
|
847
1335
|
type: object
|
|
848
1336
|
properties:
|
|
849
1337
|
id:
|
|
@@ -862,17 +1350,17 @@ components:
|
|
|
862
1350
|
examples:
|
|
863
1351
|
- '26'
|
|
864
1352
|
manage_jobs:
|
|
865
|
-
description: Whether there is permission to
|
|
1353
|
+
description: Whether there is permission to view, cancel and delete the jobs
|
|
866
1354
|
type: boolean
|
|
867
1355
|
examples:
|
|
868
1356
|
- true
|
|
869
1357
|
duplicate:
|
|
870
|
-
description: Whether there is permission to duplicate
|
|
1358
|
+
description: Whether there is permission to duplicate the workflow
|
|
871
1359
|
type: boolean
|
|
872
1360
|
examples:
|
|
873
1361
|
- true
|
|
874
1362
|
updated_at:
|
|
875
|
-
description: Time
|
|
1363
|
+
description: Time the permission is updated
|
|
876
1364
|
type: string
|
|
877
1365
|
format: date-time
|
|
878
1366
|
examples:
|
|
@@ -883,63 +1371,60 @@ components:
|
|
|
883
1371
|
format: date-time
|
|
884
1372
|
examples:
|
|
885
1373
|
- 2019-01-10T21:25:24.000Z
|
|
886
|
-
|
|
887
|
-
|
|
1374
|
+
RecipientHash:
|
|
1375
|
+
description: Recipient of a notification. The `id` is a numeric ID for `User` and `Group`, and an email address for `Email`.
|
|
888
1376
|
type: object
|
|
889
1377
|
properties:
|
|
890
|
-
|
|
891
|
-
|
|
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
|
|
1378
|
+
id:
|
|
1379
|
+
type: string
|
|
934
1380
|
examples:
|
|
935
|
-
-
|
|
936
|
-
|
|
1381
|
+
- example@email.com
|
|
1382
|
+
type:
|
|
1383
|
+
type: string
|
|
1384
|
+
enum:
|
|
1385
|
+
- User
|
|
1386
|
+
- Group
|
|
1387
|
+
- Email
|
|
1388
|
+
required:
|
|
1389
|
+
- id
|
|
1390
|
+
- type
|
|
1391
|
+
WorkflowNotifications:
|
|
1392
|
+
description: Recipients of the notifications of the workflow, by event. If `allow_notifications` is true, at least one list must be non-empty.
|
|
1393
|
+
type: object
|
|
1394
|
+
properties:
|
|
1395
|
+
started:
|
|
1396
|
+
description: Recipients notified when a job starts
|
|
937
1397
|
type: array
|
|
938
1398
|
items:
|
|
939
|
-
$ref: '#/components/schemas/
|
|
940
|
-
|
|
1399
|
+
$ref: '#/components/schemas/RecipientHash'
|
|
1400
|
+
failed:
|
|
1401
|
+
description: Recipients notified when a job fails
|
|
1402
|
+
type: array
|
|
1403
|
+
items:
|
|
1404
|
+
$ref: '#/components/schemas/RecipientHash'
|
|
1405
|
+
completed:
|
|
1406
|
+
description: Recipients notified when a job completes
|
|
1407
|
+
type: array
|
|
1408
|
+
items:
|
|
1409
|
+
$ref: '#/components/schemas/RecipientHash'
|
|
1410
|
+
WorkflowState:
|
|
1411
|
+
description: State of the workflow. `activate` on a `draft` workflow goes through `validating`, while the permissions on the nodes are requested.
|
|
1412
|
+
type: string
|
|
1413
|
+
enum:
|
|
1414
|
+
- draft
|
|
1415
|
+
- validating
|
|
1416
|
+
- active
|
|
1417
|
+
- inactive
|
|
1418
|
+
WorkflowStatus:
|
|
1419
|
+
description: Status of the workflow, from the validation of its permissions. `not_started` is the initial status, `submitted` while the permissions are requested, `success` when they are granted and `error` otherwise.
|
|
1420
|
+
type: string
|
|
1421
|
+
enum:
|
|
1422
|
+
- not_started
|
|
1423
|
+
- submitted
|
|
1424
|
+
- success
|
|
1425
|
+
- error
|
|
941
1426
|
workflowData:
|
|
942
|
-
description: Returned workflow data
|
|
1427
|
+
description: Returned workflow data. `steps` is present only for a single workflow (GET /workflows/{id}, copy) and for a list with `response_type=long`. For a workflow version, `state`, `status`, `instance_stats` and `workflow_can_activate` are not returned.
|
|
943
1428
|
type: object
|
|
944
1429
|
properties:
|
|
945
1430
|
id:
|
|
@@ -948,7 +1433,7 @@ components:
|
|
|
948
1433
|
examples:
|
|
949
1434
|
- '26'
|
|
950
1435
|
name:
|
|
951
|
-
description: Workflow name
|
|
1436
|
+
description: Workflow name. It is unique for a user.
|
|
952
1437
|
type: string
|
|
953
1438
|
examples:
|
|
954
1439
|
- test workflow
|
|
@@ -958,31 +1443,31 @@ components:
|
|
|
958
1443
|
examples:
|
|
959
1444
|
- '58'
|
|
960
1445
|
user_id:
|
|
961
|
-
description: ID of user who
|
|
1446
|
+
description: ID of the user who owns the workflow
|
|
962
1447
|
type: string
|
|
963
1448
|
examples:
|
|
964
1449
|
- '1072'
|
|
965
|
-
|
|
966
|
-
description:
|
|
1450
|
+
user_name:
|
|
1451
|
+
description: Name of the user who owns the workflow
|
|
967
1452
|
type: string
|
|
968
1453
|
examples:
|
|
969
|
-
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
-
|
|
974
|
-
-
|
|
975
|
-
status:
|
|
976
|
-
description: 'Workflow status.'
|
|
977
|
-
type: string
|
|
1454
|
+
- John Doe
|
|
1455
|
+
workflow_version_id:
|
|
1456
|
+
description: ID of the current workflow version
|
|
1457
|
+
type:
|
|
1458
|
+
- string
|
|
1459
|
+
- 'null'
|
|
978
1460
|
examples:
|
|
979
|
-
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
-
|
|
985
|
-
|
|
1461
|
+
- '150'
|
|
1462
|
+
allow_notifications:
|
|
1463
|
+
description: Whether email notifications are enabled for this workflow
|
|
1464
|
+
type: boolean
|
|
1465
|
+
examples:
|
|
1466
|
+
- true
|
|
1467
|
+
state:
|
|
1468
|
+
$ref: '#/components/schemas/WorkflowState'
|
|
1469
|
+
status:
|
|
1470
|
+
$ref: '#/components/schemas/WorkflowStatus'
|
|
986
1471
|
steps:
|
|
987
1472
|
description: Array of step data
|
|
988
1473
|
type: array
|
|
@@ -998,66 +1483,9 @@ components:
|
|
|
998
1483
|
- '1077'
|
|
999
1484
|
- '1078'
|
|
1000
1485
|
workflow_notifications:
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
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
|
|
1486
|
+
oneOf:
|
|
1487
|
+
- $ref: '#/components/schemas/WorkflowNotifications'
|
|
1488
|
+
- type: 'null'
|
|
1061
1489
|
updated_at:
|
|
1062
1490
|
description: Time workflow is updated
|
|
1063
1491
|
type: string
|
|
@@ -1065,8 +1493,10 @@ components:
|
|
|
1065
1493
|
examples:
|
|
1066
1494
|
- 2019-01-10T21:25:24.000Z
|
|
1067
1495
|
trigger_type:
|
|
1068
|
-
description:
|
|
1069
|
-
type:
|
|
1496
|
+
description: Type of the first action of the first step. Null if the workflow has no trigger yet.
|
|
1497
|
+
type:
|
|
1498
|
+
- string
|
|
1499
|
+
- 'null'
|
|
1070
1500
|
examples:
|
|
1071
1501
|
- scheduled
|
|
1072
1502
|
enum:
|
|
@@ -1074,35 +1504,56 @@ components:
|
|
|
1074
1504
|
- shared_inbox
|
|
1075
1505
|
- watch_folder
|
|
1076
1506
|
- scheduled
|
|
1507
|
+
- delete_folder
|
|
1508
|
+
- null
|
|
1077
1509
|
workflow_can_activate:
|
|
1078
|
-
description:
|
|
1510
|
+
description: True if the workflow has at least two steps and an action that transfers files or sends a package (`transfer`, `package_transfer`), or a `watch_folder`, `delete_folder`, `shared_inbox` or `antivirus` trigger or action.
|
|
1079
1511
|
type: boolean
|
|
1080
1512
|
examples:
|
|
1081
1513
|
- false
|
|
1082
1514
|
instance_stats:
|
|
1083
1515
|
$ref: '#/components/schemas/InstanceStats'
|
|
1084
|
-
|
|
1516
|
+
outputs:
|
|
1517
|
+
description: Global variables that the actions of the workflow can use as substitution variables. The values are the type names.
|
|
1518
|
+
type: object
|
|
1519
|
+
additionalProperties: true
|
|
1520
|
+
examples:
|
|
1521
|
+
- workflow_instance:
|
|
1522
|
+
uuid: string
|
|
1523
|
+
launched_at:
|
|
1524
|
+
DD: string
|
|
1525
|
+
MM: string
|
|
1526
|
+
Month: string
|
|
1527
|
+
YYYY: string
|
|
1528
|
+
hh: string
|
|
1529
|
+
mm: string
|
|
1530
|
+
date_time: string
|
|
1531
|
+
201-Workflow:
|
|
1532
|
+
description: The created workflow, without steps
|
|
1533
|
+
title: Success response
|
|
1534
|
+
allOf:
|
|
1535
|
+
- $ref: '#/components/schemas/workflowData'
|
|
1085
1536
|
InstanceStats:
|
|
1086
1537
|
description: Shows runtime statistics of a workflow
|
|
1087
1538
|
type: object
|
|
1088
1539
|
properties:
|
|
1089
1540
|
running:
|
|
1090
|
-
description: Number of
|
|
1541
|
+
description: Number of executing and initiating jobs
|
|
1091
1542
|
type: string
|
|
1092
1543
|
examples:
|
|
1093
1544
|
- '10'
|
|
1094
1545
|
failed:
|
|
1095
|
-
description: Number of failed
|
|
1546
|
+
description: Number of failed jobs
|
|
1096
1547
|
type: string
|
|
1097
1548
|
examples:
|
|
1098
1549
|
- '10'
|
|
1099
1550
|
completed:
|
|
1100
|
-
description: Number of completed
|
|
1551
|
+
description: Number of completed jobs
|
|
1101
1552
|
type: string
|
|
1102
1553
|
examples:
|
|
1103
1554
|
- '10'
|
|
1104
1555
|
Steps:
|
|
1105
|
-
description: Object that contains step data
|
|
1556
|
+
description: Object that contains step data. `actions` is present only in the long form.
|
|
1106
1557
|
type: object
|
|
1107
1558
|
properties:
|
|
1108
1559
|
id:
|
|
@@ -1112,139 +1563,62 @@ components:
|
|
|
1112
1563
|
- '1260'
|
|
1113
1564
|
name:
|
|
1114
1565
|
description: Name you assign to the step
|
|
1115
|
-
type:
|
|
1566
|
+
type:
|
|
1567
|
+
- string
|
|
1568
|
+
- 'null'
|
|
1116
1569
|
examples:
|
|
1117
1570
|
- transcode step
|
|
1118
|
-
|
|
1119
|
-
description:
|
|
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
|
|
1571
|
+
workflow_id:
|
|
1572
|
+
description: ID of the workflow that contains the step
|
|
1141
1573
|
type: string
|
|
1142
|
-
examples:
|
|
1143
|
-
- '7301'
|
|
1144
1574
|
user_id:
|
|
1145
|
-
description: User ID
|
|
1146
|
-
type: string
|
|
1147
|
-
examples:
|
|
1148
|
-
- '1230'
|
|
1149
|
-
state:
|
|
1150
|
-
description: 'The state of the workflow.'
|
|
1151
|
-
type: string
|
|
1152
|
-
examples:
|
|
1153
|
-
- draft
|
|
1154
|
-
enum:
|
|
1155
|
-
- draft
|
|
1156
|
-
- active
|
|
1157
|
-
- inactive
|
|
1158
|
-
- error
|
|
1159
|
-
status:
|
|
1160
|
-
description: 'Workflow status.'
|
|
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
1575
|
type: string
|
|
1187
|
-
|
|
1188
|
-
examples:
|
|
1189
|
-
- 2019-02-19T23:52:20.000Z
|
|
1190
|
-
trigger_type:
|
|
1191
|
-
description: 'Trigger type for the workflow.'
|
|
1576
|
+
organization_id:
|
|
1192
1577
|
type: string
|
|
1193
|
-
|
|
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.
|
|
1578
|
+
deleted:
|
|
1202
1579
|
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
1580
|
action_order:
|
|
1233
|
-
description: Order of actions in a step, listed by action ID
|
|
1581
|
+
description: Order of actions in a step, listed by action ID. The actions of a step run in parallel; this order is for display.
|
|
1234
1582
|
type: array
|
|
1235
1583
|
items:
|
|
1236
1584
|
type: string
|
|
1237
1585
|
examples:
|
|
1238
|
-
- - '
|
|
1239
|
-
- '
|
|
1240
|
-
- '1274'
|
|
1586
|
+
- - '1272'
|
|
1587
|
+
- '1263'
|
|
1241
1588
|
actions:
|
|
1242
1589
|
description: Data for actions in the step
|
|
1243
1590
|
type: array
|
|
1244
1591
|
items:
|
|
1245
1592
|
$ref: '#/components/schemas/actionData'
|
|
1593
|
+
200-StepsID:
|
|
1594
|
+
description: Returned data for a step with a unique ID.
|
|
1246
1595
|
title: Success response
|
|
1596
|
+
allOf:
|
|
1597
|
+
- $ref: '#/components/schemas/Steps'
|
|
1598
|
+
201-Step:
|
|
1599
|
+
description: The created step
|
|
1600
|
+
title: Success response
|
|
1601
|
+
allOf:
|
|
1602
|
+
- $ref: '#/components/schemas/Steps'
|
|
1603
|
+
ActionType:
|
|
1604
|
+
description: Type of an action. The first five are triggers.
|
|
1605
|
+
type: string
|
|
1606
|
+
enum:
|
|
1607
|
+
- manual
|
|
1608
|
+
- scheduled
|
|
1609
|
+
- watch_folder
|
|
1610
|
+
- shared_inbox
|
|
1611
|
+
- delete_folder
|
|
1612
|
+
- transfer
|
|
1613
|
+
- package_transfer
|
|
1614
|
+
- api
|
|
1615
|
+
- email_notification
|
|
1616
|
+
- custom_var
|
|
1617
|
+
- folder
|
|
1618
|
+
- telestream_qc
|
|
1619
|
+
- antivirus
|
|
1247
1620
|
actionData:
|
|
1621
|
+
description: Returned action data. `data` is present for a single action (GET, POST) and in the long form of a step or workflow. Sensitive values (tokens, passwords, credentials) are removed from `data`.
|
|
1248
1622
|
type: object
|
|
1249
1623
|
properties:
|
|
1250
1624
|
id:
|
|
@@ -1260,482 +1634,210 @@ components:
|
|
|
1260
1634
|
examples:
|
|
1261
1635
|
- null
|
|
1262
1636
|
type:
|
|
1263
|
-
|
|
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
|
|
1637
|
+
$ref: '#/components/schemas/ActionType'
|
|
1276
1638
|
data:
|
|
1277
|
-
description: Detailed action data
|
|
1639
|
+
description: Detailed action data, as defined by the request schema of the type. Defaults are added, for example `timeout`.
|
|
1278
1640
|
type: object
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
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
|
-
- []
|
|
1641
|
+
additionalProperties: true
|
|
1642
|
+
deleted:
|
|
1643
|
+
type: boolean
|
|
1644
|
+
step_id:
|
|
1645
|
+
type: string
|
|
1646
|
+
organization_id:
|
|
1647
|
+
type: string
|
|
1648
|
+
user_id:
|
|
1649
|
+
type: string
|
|
1312
1650
|
outputs:
|
|
1313
|
-
description:
|
|
1651
|
+
description: |-
|
|
1652
|
+
Describes the format of action outputs that can be used as substitution variables in subsequent actions. The values are the type names.
|
|
1653
|
+
|
|
1654
|
+
- `manual`: none.
|
|
1655
|
+
- `scheduled`: `timestamp`.
|
|
1656
|
+
- `watch_folder`, `delete_folder`: `filename`, `file_id`, `timestamp`, `node_id`, `file_ext`, `filepath`, `parent_path`.
|
|
1657
|
+
- `shared_inbox`: `metadata`, `name`, `message`, `shared_inbox_name`, `timestamp`, `dropbox_id`, `file_id`, `node_id`, `sender_name`, `sender_email`, `sender_type`, `sender_id`.
|
|
1658
|
+
- `transfer`: `status`, `transfer_uuid`, `timestamp`.
|
|
1659
|
+
- `package_transfer`: `package_id`, `status`, `package_subject`, `package_message`.
|
|
1660
|
+
- `api`: `status`, `response_code`, `response_body`.
|
|
1661
|
+
- `email_notification`: `status`.
|
|
1662
|
+
- `folder`: `node_id`, `file_id`, `parent_file_id`, `timestamp`.
|
|
1663
|
+
- `custom_var`: one output for each variable of `custom_variables`.
|
|
1664
|
+
- `telestream_qc`: `status`, `project_id`, `state`, `filename`, `source_url`, `created_at`, `updated_at`, `error_class`, `error_message`.
|
|
1665
|
+
- `antivirus`: `status`, `file_scanned`, `virus_detected`, `virus_file_list`.
|
|
1314
1666
|
type: object
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
- iso8601
|
|
1321
|
-
201-Step:
|
|
1667
|
+
additionalProperties:
|
|
1668
|
+
type: string
|
|
1669
|
+
examples:
|
|
1670
|
+
- timestamp: iso8601
|
|
1671
|
+
LaunchResponse:
|
|
1322
1672
|
type: object
|
|
1323
1673
|
properties:
|
|
1324
|
-
|
|
1325
|
-
|
|
1674
|
+
workflow_id:
|
|
1675
|
+
type: integer
|
|
1676
|
+
examples:
|
|
1677
|
+
- 2116
|
|
1678
|
+
message:
|
|
1326
1679
|
type: string
|
|
1327
1680
|
examples:
|
|
1328
|
-
-
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
1681
|
+
- Workflow has been triggered and will be executed.
|
|
1682
|
+
DefaultCopyName:
|
|
1683
|
+
type: object
|
|
1684
|
+
properties:
|
|
1685
|
+
default_copy_name:
|
|
1686
|
+
type: string
|
|
1334
1687
|
examples:
|
|
1335
|
-
-
|
|
1336
|
-
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
|
|
1688
|
+
- Send Files to Media (1)
|
|
1689
|
+
Ping:
|
|
1690
|
+
type: object
|
|
1691
|
+
properties:
|
|
1692
|
+
db:
|
|
1693
|
+
type: string
|
|
1694
|
+
enum:
|
|
1695
|
+
- ok
|
|
1696
|
+
- connection_lost
|
|
1697
|
+
kafka:
|
|
1698
|
+
type: string
|
|
1699
|
+
enum:
|
|
1700
|
+
- ok
|
|
1701
|
+
- connection_error
|
|
1702
|
+
ApiCallbackRequest:
|
|
1703
|
+
description: Message of the service called by an `api` action with `callback`. Other properties are forwarded as is.
|
|
1704
|
+
type: object
|
|
1705
|
+
properties:
|
|
1706
|
+
token:
|
|
1707
|
+
description: The `token` injected by Automation in the payload of the request
|
|
1708
|
+
type: string
|
|
1709
|
+
status:
|
|
1710
|
+
description: '`in_progress` to report progress, `success` or `failed` to end the action.'
|
|
1711
|
+
type: string
|
|
1341
1712
|
examples:
|
|
1342
|
-
-
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
|
|
1713
|
+
- success
|
|
1714
|
+
progress:
|
|
1715
|
+
description: Percentage of progress, with `in_progress`
|
|
1716
|
+
type: integer
|
|
1717
|
+
minimum: 0
|
|
1718
|
+
maximum: 100
|
|
1719
|
+
required:
|
|
1720
|
+
- token
|
|
1721
|
+
- status
|
|
1722
|
+
additionalProperties: true
|
|
1723
|
+
ValidateActionResponse:
|
|
1724
|
+
description: Result of the validation, by location that has an `authentication`.
|
|
1725
|
+
type: object
|
|
1726
|
+
properties:
|
|
1727
|
+
source:
|
|
1728
|
+
$ref: '#/components/schemas/CredentialValidation'
|
|
1729
|
+
destination:
|
|
1730
|
+
$ref: '#/components/schemas/CredentialValidation'
|
|
1731
|
+
CredentialValidation:
|
|
1732
|
+
type: object
|
|
1733
|
+
properties:
|
|
1734
|
+
valid:
|
|
1735
|
+
type: boolean
|
|
1736
|
+
error:
|
|
1737
|
+
description: Reason of the failure. Present only if `valid` is false.
|
|
1738
|
+
type: string
|
|
1739
|
+
examples:
|
|
1740
|
+
- Authentication failed (HTTP 401)
|
|
1741
|
+
required:
|
|
1742
|
+
- valid
|
|
1346
1743
|
substitutionVariables:
|
|
1744
|
+
description: Puts the value of a variable, or of the output of a previous action, in the field of `data` that `path` designates.
|
|
1347
1745
|
type: object
|
|
1348
1746
|
properties:
|
|
1349
1747
|
template:
|
|
1350
|
-
description:
|
|
1748
|
+
description: 'Text that contains the variables: `{{global}}` for a global variable, `{{{step_id_<STEP>.action_id_<ACTION>.<FIELD>}}}` for the output of an action.'
|
|
1351
1749
|
type: string
|
|
1352
1750
|
examples:
|
|
1353
|
-
- '{{step_id_1357.action_id_1409.node_id}}'
|
|
1751
|
+
- '{{{step_id_1357.action_id_1409.node_id}}}'
|
|
1354
1752
|
path:
|
|
1355
|
-
description: Path
|
|
1753
|
+
description: Path of the field of `data` that receives the text
|
|
1356
1754
|
type: array
|
|
1357
1755
|
items:
|
|
1358
1756
|
$ref: '#/components/schemas/substitutionVariablesPath'
|
|
1757
|
+
required:
|
|
1758
|
+
- template
|
|
1759
|
+
- path
|
|
1359
1760
|
substitutionVariablesPath:
|
|
1360
1761
|
type: object
|
|
1361
1762
|
properties:
|
|
1362
1763
|
name:
|
|
1363
|
-
description: Name
|
|
1764
|
+
description: Name of the field in `data` (for a `map`).
|
|
1364
1765
|
type: string
|
|
1365
1766
|
examples:
|
|
1366
|
-
- message
|
|
1367
|
-
enum:
|
|
1368
1767
|
- source
|
|
1369
|
-
- file_id
|
|
1370
|
-
- node_id
|
|
1371
|
-
- message
|
|
1372
|
-
- value
|
|
1373
|
-
- conditions
|
|
1374
1768
|
type:
|
|
1375
|
-
description:
|
|
1769
|
+
description: Path type. `map` is an object key, `array` a list; `input_map` is accepted by `custom_var` only.
|
|
1376
1770
|
type: string
|
|
1377
1771
|
examples:
|
|
1378
1772
|
- map
|
|
1379
1773
|
enum:
|
|
1380
1774
|
- map
|
|
1381
1775
|
- array
|
|
1776
|
+
- input_map
|
|
1382
1777
|
index:
|
|
1383
|
-
description: Index
|
|
1384
|
-
type:
|
|
1778
|
+
description: Index in the list (for an `array`)
|
|
1779
|
+
type:
|
|
1780
|
+
- integer
|
|
1781
|
+
- string
|
|
1385
1782
|
examples:
|
|
1386
1783
|
- 0
|
|
1387
|
-
|
|
1784
|
+
required:
|
|
1785
|
+
- type
|
|
1786
|
+
Step:
|
|
1388
1787
|
type: object
|
|
1389
1788
|
properties:
|
|
1390
|
-
|
|
1391
|
-
description:
|
|
1789
|
+
workflow_id:
|
|
1790
|
+
description: ID of workflow that contains the step
|
|
1392
1791
|
type: string
|
|
1393
1792
|
examples:
|
|
1394
|
-
- '
|
|
1793
|
+
- '1260'
|
|
1395
1794
|
name:
|
|
1396
|
-
description:
|
|
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.
|
|
1795
|
+
description: The name of the step
|
|
1404
1796
|
type: string
|
|
1405
1797
|
examples:
|
|
1406
|
-
-
|
|
1407
|
-
|
|
1408
|
-
|
|
1409
|
-
|
|
1410
|
-
|
|
1411
|
-
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
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. Use 'bearer' for bearer token authentication, 'basic' for basic authentication, 'none' for no authentication method.
|
|
1428
|
-
|
|
1429
|
-
The bearer authentication type requires a token parameter. 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:
|
|
1798
|
+
- transfer step
|
|
1799
|
+
action_order:
|
|
1800
|
+
description: Order of actions in a step, listed by action ID
|
|
1801
|
+
type: array
|
|
1802
|
+
items:
|
|
1803
|
+
type: string
|
|
1804
|
+
examples:
|
|
1805
|
+
- - '1273'
|
|
1806
|
+
- '1262'
|
|
1807
|
+
- '1274'
|
|
1808
|
+
required:
|
|
1809
|
+
- workflow_id
|
|
1810
|
+
createWorkflowRequest:
|
|
1484
1811
|
type: object
|
|
1812
|
+
title: Creates a new workflow
|
|
1485
1813
|
properties:
|
|
1486
|
-
id:
|
|
1487
|
-
description: Action ID
|
|
1488
|
-
type: string
|
|
1489
|
-
examples:
|
|
1490
|
-
- '647'
|
|
1491
1814
|
name:
|
|
1492
|
-
description:
|
|
1815
|
+
description: Name of new workflow. It must be unique among the workflows of the user.
|
|
1493
1816
|
type: string
|
|
1494
1817
|
examples:
|
|
1495
|
-
-
|
|
1496
|
-
|
|
1497
|
-
description:
|
|
1498
|
-
type:
|
|
1818
|
+
- Send Files to Media
|
|
1819
|
+
hidden:
|
|
1820
|
+
description: Whether the workflow is hidden. A hidden workflow is not listed, and only the Secure Reports Service can access it.
|
|
1821
|
+
type: boolean
|
|
1499
1822
|
examples:
|
|
1500
|
-
-
|
|
1501
|
-
|
|
1502
|
-
description:
|
|
1503
|
-
type:
|
|
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.'
|
|
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.'
|
|
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.'
|
|
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: all_new transfers all new files, custom adds custom filtering conditions.'
|
|
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
|
|
1823
|
+
- false
|
|
1824
|
+
allow_notifications:
|
|
1825
|
+
description: Whether email notifications are enabled
|
|
1826
|
+
type: boolean
|
|
1713
1827
|
examples:
|
|
1714
|
-
-
|
|
1715
|
-
|
|
1716
|
-
|
|
1828
|
+
- false
|
|
1829
|
+
workflow_notifications:
|
|
1830
|
+
$ref: '#/components/schemas/WorkflowNotifications'
|
|
1831
|
+
step_order:
|
|
1832
|
+
description: Order of steps. Normally empty at creation.
|
|
1717
1833
|
type: array
|
|
1718
1834
|
items:
|
|
1719
1835
|
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
1836
|
required:
|
|
1735
1837
|
- name
|
|
1736
|
-
title: Creates a new workflow
|
|
1737
1838
|
createWorkflowPermissionRequest:
|
|
1738
1839
|
type: object
|
|
1840
|
+
title: Creates a new workflow permission
|
|
1739
1841
|
properties:
|
|
1740
1842
|
user_id:
|
|
1741
1843
|
description: User ID to associate with the permission
|
|
@@ -1747,33 +1849,38 @@ components:
|
|
|
1747
1849
|
type: string
|
|
1748
1850
|
examples:
|
|
1749
1851
|
- '32'
|
|
1852
|
+
organization_id:
|
|
1853
|
+
description: ID of organization
|
|
1854
|
+
type: string
|
|
1855
|
+
examples:
|
|
1856
|
+
- '58'
|
|
1857
|
+
edit:
|
|
1858
|
+
description: Whether to give permission to edit the workflow. It implies the other permissions in the checks of the API.
|
|
1859
|
+
type: boolean
|
|
1860
|
+
default: false
|
|
1750
1861
|
duplicate:
|
|
1751
1862
|
description: Whether to give permission to duplicate the workflow
|
|
1752
1863
|
type: boolean
|
|
1753
|
-
|
|
1754
|
-
- true
|
|
1864
|
+
default: false
|
|
1755
1865
|
manage_jobs:
|
|
1756
1866
|
description: Whether to give permission to manage workflow jobs
|
|
1757
1867
|
type: boolean
|
|
1758
|
-
|
|
1759
|
-
- true
|
|
1868
|
+
default: false
|
|
1760
1869
|
required:
|
|
1761
1870
|
- user_id
|
|
1762
1871
|
- workflow_id
|
|
1763
|
-
- duplicate
|
|
1764
|
-
- manage_jobs
|
|
1765
|
-
title: Creates a new workflow permission
|
|
1766
1872
|
updateWorkflow:
|
|
1767
|
-
description: Updates
|
|
1873
|
+
description: Updates an existing workflow
|
|
1874
|
+
title: Updates an existing workflow
|
|
1768
1875
|
type: object
|
|
1769
1876
|
properties:
|
|
1770
1877
|
name:
|
|
1771
|
-
description: Name of
|
|
1878
|
+
description: Name of workflow
|
|
1772
1879
|
type: string
|
|
1773
1880
|
examples:
|
|
1774
1881
|
- Send Files to Media
|
|
1775
1882
|
step_order:
|
|
1776
|
-
description: Array of workflow steps, in the order they appear in the workflow
|
|
1883
|
+
description: Array of workflow steps, in the order they appear in the workflow. The first step contains the trigger.
|
|
1777
1884
|
type: array
|
|
1778
1885
|
items:
|
|
1779
1886
|
type: string
|
|
@@ -1781,31 +1888,43 @@ components:
|
|
|
1781
1888
|
- - '321'
|
|
1782
1889
|
- '123'
|
|
1783
1890
|
- '111'
|
|
1784
|
-
|
|
1785
|
-
|
|
1786
|
-
|
|
1787
|
-
|
|
1891
|
+
allow_notifications:
|
|
1892
|
+
description: Whether email notifications are enabled for this workflow
|
|
1893
|
+
type: boolean
|
|
1894
|
+
examples:
|
|
1895
|
+
- true
|
|
1896
|
+
workflow_notifications:
|
|
1897
|
+
$ref: '#/components/schemas/WorkflowNotifications'
|
|
1898
|
+
hidden:
|
|
1899
|
+
description: Whether the workflow is hidden
|
|
1900
|
+
type: boolean
|
|
1788
1901
|
cancelWorkflowInstance:
|
|
1902
|
+
title: Set the status of a job
|
|
1789
1903
|
type: object
|
|
1790
1904
|
properties:
|
|
1791
1905
|
status:
|
|
1792
|
-
description: Status of the workflow instance. To cancel a workflow instance, the value is
|
|
1906
|
+
description: Status of the workflow instance. To cancel a workflow instance, the value is `canceled`. Any other value of the enumeration is accepted and sent to the workflow engine; another value is rejected with 422.
|
|
1793
1907
|
type: string
|
|
1794
1908
|
examples:
|
|
1795
1909
|
- canceled
|
|
1796
1910
|
enum:
|
|
1911
|
+
- initiating
|
|
1912
|
+
- executing
|
|
1913
|
+
- queued
|
|
1914
|
+
- queue_full
|
|
1915
|
+
- paused
|
|
1916
|
+
- resumed
|
|
1917
|
+
- complete
|
|
1918
|
+
- failed
|
|
1797
1919
|
- canceled
|
|
1920
|
+
- timeout
|
|
1921
|
+
- deleted
|
|
1798
1922
|
required:
|
|
1799
1923
|
- status
|
|
1800
|
-
|
|
1801
|
-
|
|
1924
|
+
updateStepRequest:
|
|
1925
|
+
title: Updates a step
|
|
1802
1926
|
type: object
|
|
1803
1927
|
properties:
|
|
1804
|
-
workflow_id:
|
|
1805
|
-
description: ID of the workflow
|
|
1806
|
-
type: string
|
|
1807
|
-
examples:
|
|
1808
|
-
- '2512'
|
|
1809
1928
|
name:
|
|
1810
1929
|
description: Name of the step
|
|
1811
1930
|
type: string
|
|
@@ -1820,397 +1939,114 @@ components:
|
|
|
1820
1939
|
- - '1273'
|
|
1821
1940
|
- '1262'
|
|
1822
1941
|
- '1274'
|
|
1823
|
-
|
|
1824
|
-
|
|
1825
|
-
title: Creates a new step
|
|
1826
|
-
createActionAPI:
|
|
1942
|
+
updateState:
|
|
1943
|
+
title: Updates the state of the workflow
|
|
1827
1944
|
type: object
|
|
1828
1945
|
properties:
|
|
1829
|
-
|
|
1830
|
-
description:
|
|
1831
|
-
type: object
|
|
1832
|
-
properties:
|
|
1833
|
-
method:
|
|
1834
|
-
description: 'API method for the request.'
|
|
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. Use 'bearer' for bearer token authentication, 'basic' for basic authentication, 'none' for no authentication method.
|
|
1855
|
-
|
|
1856
|
-
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.
|
|
1946
|
+
event:
|
|
1947
|
+
description: Request a state change. `save_as_draft` makes the workflow editable. `activate` goes to `active`, through `validating` from `draft`. `deactivate` goes to `inactive`; the running jobs are not stopped.
|
|
1896
1948
|
type: string
|
|
1897
1949
|
examples:
|
|
1898
|
-
-
|
|
1950
|
+
- save_as_draft
|
|
1899
1951
|
enum:
|
|
1900
|
-
-
|
|
1901
|
-
|
|
1902
|
-
|
|
1952
|
+
- save_as_draft
|
|
1953
|
+
- activate
|
|
1954
|
+
- deactivate
|
|
1955
|
+
required:
|
|
1956
|
+
- event
|
|
1957
|
+
updateWorkflowPermissionRequest:
|
|
1958
|
+
title: Updates an existing workflow permission
|
|
1959
|
+
type: object
|
|
1960
|
+
properties:
|
|
1961
|
+
edit:
|
|
1962
|
+
description: Whether to give permission to edit the workflow
|
|
1963
|
+
type: boolean
|
|
1964
|
+
duplicate:
|
|
1965
|
+
description: Whether to give permission to duplicate the workflow
|
|
1966
|
+
type: boolean
|
|
1967
|
+
manage_jobs:
|
|
1968
|
+
description: Whether to give permission to manage workflow jobs
|
|
1969
|
+
type: boolean
|
|
1970
|
+
AppPermissions:
|
|
1971
|
+
description: Application permissions and settings for an organization
|
|
1972
|
+
title: Automation App Permissions
|
|
1973
|
+
type: object
|
|
1974
|
+
properties:
|
|
1975
|
+
organization_id:
|
|
1903
1976
|
type: string
|
|
1904
1977
|
examples:
|
|
1905
|
-
- '
|
|
1978
|
+
- '58'
|
|
1979
|
+
failed_count_to_deactivate:
|
|
1980
|
+
description: Number of consecutive failed workflow runs before automatic deactivation. The default is 10.
|
|
1981
|
+
type: integer
|
|
1982
|
+
examples:
|
|
1983
|
+
- 10
|
|
1984
|
+
enabled:
|
|
1985
|
+
description: Whether the Automation application is enabled for the organization
|
|
1986
|
+
type: boolean
|
|
1987
|
+
available:
|
|
1988
|
+
description: Whether the Automation application is available to the organization (edition)
|
|
1989
|
+
type: boolean
|
|
1990
|
+
updateAppPermissionsRequest:
|
|
1991
|
+
description: Request payload to update application permissions for an organization
|
|
1992
|
+
title: Update Automation App Permissions Request
|
|
1993
|
+
type: object
|
|
1994
|
+
properties:
|
|
1995
|
+
failed_count_to_deactivate:
|
|
1996
|
+
description: Number of consecutive failed workflow runs before automatic deactivation
|
|
1997
|
+
type: integer
|
|
1998
|
+
examples:
|
|
1999
|
+
- 5
|
|
1906
2000
|
required:
|
|
1907
|
-
-
|
|
1908
|
-
- type
|
|
1909
|
-
- step_id
|
|
1910
|
-
title: Creates a new action that calls an API
|
|
2001
|
+
- failed_count_to_deactivate
|
|
1911
2002
|
Headers:
|
|
1912
2003
|
type: object
|
|
1913
2004
|
properties:
|
|
1914
2005
|
key:
|
|
1915
2006
|
description: Header key
|
|
1916
|
-
type:
|
|
2007
|
+
type:
|
|
2008
|
+
- string
|
|
2009
|
+
- 'null'
|
|
1917
2010
|
examples:
|
|
1918
2011
|
- Content-Type
|
|
1919
2012
|
value:
|
|
1920
2013
|
description: Header value
|
|
1921
|
-
type:
|
|
2014
|
+
type:
|
|
2015
|
+
- string
|
|
2016
|
+
- 'null'
|
|
1922
2017
|
examples:
|
|
1923
2018
|
- text/html
|
|
1924
2019
|
required:
|
|
1925
2020
|
- key
|
|
1926
2021
|
- value
|
|
1927
|
-
|
|
1928
|
-
description:
|
|
2022
|
+
Paths:
|
|
2023
|
+
description: A path of a location. A `source` location uses `source` (`"/"` is the location itself); a `destination` location uses `destination` (a folder to create at the destination, which can contain substitution variables).
|
|
1929
2024
|
type: object
|
|
1930
2025
|
properties:
|
|
1931
|
-
|
|
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.'
|
|
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: all_new transfers all new files, custom adds custom filtering conditions.'
|
|
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.'
|
|
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.'
|
|
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.'
|
|
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.'
|
|
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.'
|
|
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, from 1 hour to 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
|
|
2026
|
+
source:
|
|
2185
2027
|
type: string
|
|
2186
2028
|
examples:
|
|
2187
|
-
-
|
|
2188
|
-
|
|
2189
|
-
description: Action type. For an action that transfers a file, the type is always transfer.
|
|
2029
|
+
- /
|
|
2030
|
+
destination:
|
|
2190
2031
|
type: string
|
|
2191
2032
|
examples:
|
|
2192
|
-
-
|
|
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
|
|
2033
|
+
- '{{workflow_instance.uuid}}'
|
|
2200
2034
|
Conditions:
|
|
2035
|
+
description: A condition of a `transfer`, `package_transfer`, `watch_folder` or `delete_folder` filter.
|
|
2201
2036
|
type: object
|
|
2202
2037
|
properties:
|
|
2203
2038
|
field_name:
|
|
2204
|
-
description:
|
|
2039
|
+
description: Name of the field. `file_name`, `extension_name` and `file_size` for `watch_folder`; `file_name`, `folder_name` and `extension_name` for `delete_folder`.
|
|
2205
2040
|
type: string
|
|
2206
2041
|
examples:
|
|
2207
2042
|
- file_name
|
|
2208
2043
|
enum:
|
|
2209
2044
|
- file_name
|
|
2045
|
+
- folder_name
|
|
2210
2046
|
- extension_name
|
|
2211
2047
|
- file_size
|
|
2212
2048
|
field_type:
|
|
2213
|
-
description: '
|
|
2049
|
+
description: '`string` with `file_name`, `folder_name` and `extension_name`; `byte` with `file_size` (`watch_folder` only).'
|
|
2214
2050
|
type: string
|
|
2215
2051
|
examples:
|
|
2216
2052
|
- string
|
|
@@ -2218,7 +2054,7 @@ components:
|
|
|
2218
2054
|
- string
|
|
2219
2055
|
- byte
|
|
2220
2056
|
match_type:
|
|
2221
|
-
description: '
|
|
2057
|
+
description: '`includes`, `excludes`, `matches`, `regex` (and `equal`, `does_not_match` for a `watch_folder`) with a string field. `equal`, `greater_than`, `less_than`, `greater_than_or_equal`, `less_than_or_equal` with `file_size`. `delete_folder` accepts `includes`, `excludes`, `matches` and `regex`.'
|
|
2222
2058
|
type: string
|
|
2223
2059
|
examples:
|
|
2224
2060
|
- includes
|
|
@@ -2226,6 +2062,7 @@ components:
|
|
|
2226
2062
|
- includes
|
|
2227
2063
|
- excludes
|
|
2228
2064
|
- matches
|
|
2065
|
+
- does_not_match
|
|
2229
2066
|
- regex
|
|
2230
2067
|
- equal
|
|
2231
2068
|
- greater_than
|
|
@@ -2233,163 +2070,1326 @@ components:
|
|
|
2233
2070
|
- greater_than_or_equal
|
|
2234
2071
|
- less_than_or_equal
|
|
2235
2072
|
value:
|
|
2236
|
-
description: Value of the condition
|
|
2237
|
-
|
|
2073
|
+
description: Value of the condition. A string (a list of strings for a `watch_folder`), or a number of bytes for `file_size`.
|
|
2074
|
+
oneOf:
|
|
2075
|
+
- type: string
|
|
2076
|
+
- type: integer
|
|
2077
|
+
- type: array
|
|
2078
|
+
items:
|
|
2079
|
+
type: string
|
|
2080
|
+
- type: array
|
|
2081
|
+
items:
|
|
2082
|
+
type: integer
|
|
2238
2083
|
examples:
|
|
2239
2084
|
- .jpg
|
|
2240
|
-
|
|
2241
|
-
|
|
2242
|
-
|
|
2243
|
-
|
|
2244
|
-
- 500000
|
|
2085
|
+
required:
|
|
2086
|
+
type: boolean
|
|
2087
|
+
max_length:
|
|
2088
|
+
type: string
|
|
2245
2089
|
required:
|
|
2246
2090
|
- field_name
|
|
2247
2091
|
- field_type
|
|
2248
2092
|
- match_type
|
|
2249
|
-
|
|
2250
|
-
|
|
2093
|
+
SharedInboxCondition:
|
|
2094
|
+
description: A condition on a metadata field of the shared inbox
|
|
2251
2095
|
type: object
|
|
2252
2096
|
properties:
|
|
2253
2097
|
id:
|
|
2254
|
-
description: Recipient ID
|
|
2255
2098
|
type: string
|
|
2256
|
-
|
|
2257
|
-
- '3201'
|
|
2258
|
-
type:
|
|
2259
|
-
description: 'User type of recipient.'
|
|
2099
|
+
field_name:
|
|
2260
2100
|
type: string
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
enum:
|
|
2101
|
+
field_type:
|
|
2102
|
+
type: string
|
|
2103
|
+
enum:
|
|
2104
|
+
- single-text
|
|
2105
|
+
- single-text-read-only
|
|
2106
|
+
- textbox
|
|
2107
|
+
- multiple-checkbox
|
|
2108
|
+
- single-dropdown
|
|
2109
|
+
- date
|
|
2110
|
+
match_type:
|
|
2111
|
+
type: string
|
|
2112
|
+
enum:
|
|
2113
|
+
- excludes
|
|
2114
|
+
- regex
|
|
2115
|
+
- includes
|
|
2116
|
+
- matches
|
|
2117
|
+
- does_not_match
|
|
2118
|
+
- equal
|
|
2119
|
+
- on_or_after
|
|
2120
|
+
- on
|
|
2121
|
+
- after
|
|
2122
|
+
- before
|
|
2123
|
+
- on_or_before
|
|
2124
|
+
value:
|
|
2125
|
+
type:
|
|
2126
|
+
- array
|
|
2127
|
+
- string
|
|
2128
|
+
required:
|
|
2129
|
+
type: boolean
|
|
2130
|
+
max_length:
|
|
2131
|
+
type: string
|
|
2132
|
+
additionalProperties: false
|
|
2133
|
+
TransferAuthentication:
|
|
2134
|
+
description: Credentials of an unmanaged node. Null for a node managed by Aspera on Cloud. The credentials are encrypted, and are not returned.
|
|
2135
|
+
oneOf:
|
|
2136
|
+
- type: 'null'
|
|
2137
|
+
- title: node_api
|
|
2138
|
+
type: object
|
|
2139
|
+
properties:
|
|
2140
|
+
type:
|
|
2141
|
+
type: string
|
|
2142
|
+
enum:
|
|
2143
|
+
- node_api
|
|
2144
|
+
credentials:
|
|
2145
|
+
type: string
|
|
2146
|
+
description: Base64-encoded username:password
|
|
2147
|
+
validate_tls:
|
|
2148
|
+
type:
|
|
2149
|
+
- boolean
|
|
2150
|
+
- 'null'
|
|
2151
|
+
required:
|
|
2152
|
+
- type
|
|
2153
|
+
additionalProperties: false
|
|
2154
|
+
- title: ssh
|
|
2155
|
+
type: object
|
|
2156
|
+
properties:
|
|
2157
|
+
type:
|
|
2158
|
+
type: string
|
|
2159
|
+
enum:
|
|
2160
|
+
- ssh
|
|
2161
|
+
credentials:
|
|
2162
|
+
type: string
|
|
2163
|
+
description: 'Base64-encoded username:password:: (password) or username::private_key:passphrase (key)'
|
|
2164
|
+
required:
|
|
2165
|
+
- type
|
|
2166
|
+
- credentials
|
|
2167
|
+
additionalProperties: false
|
|
2168
|
+
TargetRate:
|
|
2169
|
+
description: Rate and retry conditions for the transfer
|
|
2170
|
+
type: object
|
|
2171
|
+
properties:
|
|
2172
|
+
rate:
|
|
2173
|
+
description: Transfer rate in Kbps
|
|
2174
|
+
type: integer
|
|
2175
|
+
examples:
|
|
2176
|
+
- 100000
|
|
2177
|
+
allow_retry:
|
|
2178
|
+
description: Whether to allow retry of a failed transfer
|
|
2179
|
+
type: boolean
|
|
2180
|
+
retry_attempts:
|
|
2181
|
+
description: Number of times Automation can retry the transfer
|
|
2182
|
+
type: integer
|
|
2183
|
+
retry_interval:
|
|
2184
|
+
description: Length of time to wait before retrying the transfer, in seconds
|
|
2185
|
+
type: integer
|
|
2186
|
+
additionalProperties: false
|
|
2187
|
+
ContentEncryption:
|
|
2188
|
+
description: Encryption of the content in transit
|
|
2189
|
+
type: object
|
|
2190
|
+
properties:
|
|
2191
|
+
encryption:
|
|
2192
|
+
type: string
|
|
2193
|
+
enum:
|
|
2194
|
+
- none
|
|
2195
|
+
- aes-128
|
|
2196
|
+
- aes-192
|
|
2197
|
+
- aes-256
|
|
2198
|
+
apply_protection:
|
|
2199
|
+
description: Apply content protection (password) to the file transfer
|
|
2200
|
+
type: boolean
|
|
2201
|
+
password:
|
|
2202
|
+
description: Password of the content protection, used if `apply_protection` is true.
|
|
2203
|
+
type:
|
|
2204
|
+
- string
|
|
2205
|
+
- 'null'
|
|
2206
|
+
additionalProperties: false
|
|
2207
|
+
TransferSourceArchive:
|
|
2208
|
+
description: What to do with the source after the transfer. With `archive`, `move_after_transfer` is required. With `delete` or `none`, the three `remove_*` options are accepted.
|
|
2209
|
+
type: object
|
|
2210
|
+
properties:
|
|
2211
|
+
archive_option:
|
|
2212
|
+
type: string
|
|
2213
|
+
enum:
|
|
2214
|
+
- none
|
|
2215
|
+
- archive
|
|
2216
|
+
- delete
|
|
2217
|
+
move_after_transfer:
|
|
2218
|
+
description: Archive folder, relative to the source node
|
|
2219
|
+
type: string
|
|
2220
|
+
examples:
|
|
2221
|
+
- /abc/def
|
|
2222
|
+
remove_empty_directories:
|
|
2223
|
+
type: boolean
|
|
2224
|
+
remove_empty_source_dir:
|
|
2225
|
+
type: boolean
|
|
2226
|
+
remove_skipped:
|
|
2227
|
+
description: Delete the files skipped because they already exist at the destination
|
|
2228
|
+
type: boolean
|
|
2229
|
+
additionalProperties: false
|
|
2230
|
+
TransferSource:
|
|
2231
|
+
description: |-
|
|
2232
|
+
Source of a transfer. `node_id` is a numeric string, or null. Accepted shapes, with `paths` always required:
|
|
2233
|
+
- `type: node`: `node_id` and `file_id`, or `node_id` and `root_file_id`, or `access_key` and `node_url` (unmanaged node).
|
|
2234
|
+
- `type: workspace`: `node_id` and `file_id`, or `node_id` and `root_file_id`.
|
|
2235
|
+
|
|
2236
|
+
For "same as trigger", `node_id` and `file_id` are null.
|
|
2237
|
+
type: object
|
|
2238
|
+
properties:
|
|
2239
|
+
type:
|
|
2240
|
+
type: string
|
|
2241
|
+
enum:
|
|
2242
|
+
- node
|
|
2243
|
+
- workspace
|
|
2244
|
+
node_id:
|
|
2245
|
+
type:
|
|
2246
|
+
- string
|
|
2247
|
+
- 'null'
|
|
2248
|
+
pattern: ^[0-9]+$
|
|
2249
|
+
examples:
|
|
2250
|
+
- '95'
|
|
2251
|
+
file_id:
|
|
2252
|
+
type:
|
|
2253
|
+
- string
|
|
2254
|
+
- 'null'
|
|
2255
|
+
examples:
|
|
2256
|
+
- '1730980'
|
|
2257
|
+
root_file_id:
|
|
2258
|
+
type:
|
|
2259
|
+
- string
|
|
2260
|
+
- 'null'
|
|
2261
|
+
node_name:
|
|
2262
|
+
type: string
|
|
2263
|
+
examples:
|
|
2264
|
+
- Tor02_node
|
|
2265
|
+
file_name:
|
|
2266
|
+
type: string
|
|
2267
|
+
examples:
|
|
2268
|
+
- 01-test
|
|
2269
|
+
workspace_id:
|
|
2270
|
+
type: string
|
|
2271
|
+
workspace_name:
|
|
2272
|
+
type: string
|
|
2273
|
+
paths:
|
|
2274
|
+
type: array
|
|
2275
|
+
items:
|
|
2276
|
+
$ref: '#/components/schemas/Paths'
|
|
2277
|
+
transfer_contents_only:
|
|
2278
|
+
type: boolean
|
|
2279
|
+
token:
|
|
2280
|
+
type: string
|
|
2281
|
+
access_key:
|
|
2282
|
+
type:
|
|
2283
|
+
- string
|
|
2284
|
+
- 'null'
|
|
2285
|
+
node_url:
|
|
2286
|
+
type: string
|
|
2287
|
+
authentication:
|
|
2288
|
+
$ref: '#/components/schemas/TransferAuthentication'
|
|
2289
|
+
required:
|
|
2290
|
+
- type
|
|
2291
|
+
- paths
|
|
2292
|
+
additionalProperties: false
|
|
2293
|
+
TransferDestination:
|
|
2294
|
+
description: |-
|
|
2295
|
+
Destination of a transfer. `node_id` is a numeric string. Accepted shapes, with `paths` always required:
|
|
2296
|
+
- `type: node`: `node_id` and `file_id`, or `access_key` and `node_url` (unmanaged node).
|
|
2297
|
+
- `type: workspace`: `workspace_id`, `workspace_name`, `node_id` and `file_name`; `file_id` is optional.
|
|
2298
|
+
type: object
|
|
2299
|
+
properties:
|
|
2300
|
+
type:
|
|
2301
|
+
type: string
|
|
2302
|
+
enum:
|
|
2303
|
+
- node
|
|
2304
|
+
- workspace
|
|
2305
|
+
node_id:
|
|
2306
|
+
type:
|
|
2307
|
+
- string
|
|
2308
|
+
- 'null'
|
|
2309
|
+
pattern: ^[0-9]+$
|
|
2310
|
+
examples:
|
|
2311
|
+
- '95'
|
|
2312
|
+
file_id:
|
|
2313
|
+
type:
|
|
2314
|
+
- string
|
|
2315
|
+
- 'null'
|
|
2316
|
+
examples:
|
|
2317
|
+
- '1818255'
|
|
2318
|
+
root_file_id:
|
|
2319
|
+
type:
|
|
2320
|
+
- string
|
|
2321
|
+
- 'null'
|
|
2322
|
+
node_name:
|
|
2323
|
+
type: string
|
|
2324
|
+
file_name:
|
|
2325
|
+
type: string
|
|
2326
|
+
examples:
|
|
2327
|
+
- folder1
|
|
2328
|
+
workspace_id:
|
|
2329
|
+
type: string
|
|
2330
|
+
workspace_name:
|
|
2331
|
+
type: string
|
|
2332
|
+
paths:
|
|
2333
|
+
type: array
|
|
2334
|
+
items:
|
|
2335
|
+
$ref: '#/components/schemas/Paths'
|
|
2336
|
+
token:
|
|
2337
|
+
type: string
|
|
2338
|
+
access_key:
|
|
2339
|
+
type:
|
|
2340
|
+
- string
|
|
2341
|
+
- 'null'
|
|
2342
|
+
node_url:
|
|
2343
|
+
type: string
|
|
2344
|
+
authentication:
|
|
2345
|
+
$ref: '#/components/schemas/TransferAuthentication'
|
|
2346
|
+
required:
|
|
2347
|
+
- type
|
|
2348
|
+
- paths
|
|
2349
|
+
additionalProperties: false
|
|
2350
|
+
TransferData:
|
|
2351
|
+
description: 'Data of a `transfer` action. When `conditions_type` is `custom`, `join_type` and at least one condition are required; when it is `all_new`, `conditions` must be empty. The source and the destination must differ. `timeout` is in milliseconds: 86400000 (24 h) when omitted.'
|
|
2352
|
+
type: object
|
|
2353
|
+
properties:
|
|
2354
|
+
name:
|
|
2355
|
+
type: string
|
|
2356
|
+
timeout:
|
|
2357
|
+
type:
|
|
2358
|
+
- integer
|
|
2359
|
+
- 'null'
|
|
2360
|
+
examples:
|
|
2361
|
+
- 86400000
|
|
2362
|
+
source:
|
|
2363
|
+
$ref: '#/components/schemas/TransferSource'
|
|
2364
|
+
destination:
|
|
2365
|
+
$ref: '#/components/schemas/TransferDestination'
|
|
2366
|
+
rate_policy:
|
|
2367
|
+
type: string
|
|
2368
|
+
enum:
|
|
2369
|
+
- fair
|
|
2370
|
+
- low
|
|
2371
|
+
- high
|
|
2372
|
+
- fixed
|
|
2373
|
+
target_rate:
|
|
2374
|
+
$ref: '#/components/schemas/TargetRate'
|
|
2375
|
+
content_encryption:
|
|
2376
|
+
$ref: '#/components/schemas/ContentEncryption'
|
|
2377
|
+
resume_policy:
|
|
2378
|
+
type: object
|
|
2379
|
+
properties:
|
|
2380
|
+
resume_partials:
|
|
2381
|
+
description: Resume partial transfers
|
|
2382
|
+
type: boolean
|
|
2383
|
+
allow_retry:
|
|
2384
|
+
type: boolean
|
|
2385
|
+
difference_check:
|
|
2386
|
+
type: string
|
|
2387
|
+
enum:
|
|
2388
|
+
- attrs
|
|
2389
|
+
- none
|
|
2390
|
+
destination_file_options:
|
|
2391
|
+
type: string
|
|
2392
|
+
enum:
|
|
2393
|
+
- overwrite_always
|
|
2394
|
+
- overwrite_newer
|
|
2395
|
+
- overwrite_different
|
|
2396
|
+
- overwrite_both_newer_different
|
|
2397
|
+
- overwrite_never
|
|
2398
|
+
additionalProperties: false
|
|
2399
|
+
file_attributes:
|
|
2400
|
+
description: Preserve the file attributes
|
|
2401
|
+
type: boolean
|
|
2402
|
+
srs_action:
|
|
2403
|
+
type: boolean
|
|
2404
|
+
bearer_token:
|
|
2405
|
+
type: string
|
|
2406
|
+
source_archive:
|
|
2407
|
+
$ref: '#/components/schemas/TransferSourceArchive'
|
|
2408
|
+
conditions_type:
|
|
2409
|
+
type: string
|
|
2410
|
+
enum:
|
|
2411
|
+
- all_new
|
|
2412
|
+
- custom
|
|
2413
|
+
join_type:
|
|
2414
|
+
type: string
|
|
2415
|
+
enum:
|
|
2416
|
+
- and
|
|
2417
|
+
- or
|
|
2418
|
+
conditions:
|
|
2419
|
+
type: array
|
|
2420
|
+
items:
|
|
2421
|
+
$ref: '#/components/schemas/Conditions'
|
|
2422
|
+
substitutions:
|
|
2423
|
+
type: array
|
|
2424
|
+
items:
|
|
2425
|
+
$ref: '#/components/schemas/substitutionVariables'
|
|
2426
|
+
required:
|
|
2427
|
+
- source
|
|
2428
|
+
- destination
|
|
2429
|
+
additionalProperties: false
|
|
2430
|
+
PackageRecipient:
|
|
2431
|
+
type: object
|
|
2432
|
+
properties:
|
|
2433
|
+
id:
|
|
2434
|
+
type:
|
|
2435
|
+
- string
|
|
2436
|
+
- 'null'
|
|
2437
|
+
type:
|
|
2438
|
+
description: Lowercase, unlike `email_notification`.
|
|
2439
|
+
type: string
|
|
2440
|
+
enum:
|
|
2441
|
+
- dropbox
|
|
2264
2442
|
- user
|
|
2265
|
-
-
|
|
2443
|
+
- email
|
|
2444
|
+
- newEmail
|
|
2445
|
+
- group
|
|
2446
|
+
name:
|
|
2447
|
+
type:
|
|
2448
|
+
- string
|
|
2449
|
+
- 'null'
|
|
2450
|
+
required:
|
|
2451
|
+
- type
|
|
2452
|
+
additionalProperties: false
|
|
2453
|
+
PackageDefinition:
|
|
2454
|
+
type: object
|
|
2455
|
+
properties:
|
|
2456
|
+
workspace_id:
|
|
2457
|
+
type: string
|
|
2458
|
+
name:
|
|
2459
|
+
type:
|
|
2460
|
+
- string
|
|
2461
|
+
- 'null'
|
|
2462
|
+
note:
|
|
2463
|
+
type:
|
|
2464
|
+
- string
|
|
2465
|
+
- 'null'
|
|
2466
|
+
send_as_type:
|
|
2467
|
+
type:
|
|
2468
|
+
- string
|
|
2469
|
+
- 'null'
|
|
2470
|
+
content_retention_duration:
|
|
2471
|
+
description: Seconds
|
|
2472
|
+
type: integer
|
|
2473
|
+
delete_package_content_after_download_duration:
|
|
2474
|
+
type: boolean
|
|
2475
|
+
watermark:
|
|
2476
|
+
type: boolean
|
|
2477
|
+
encryption_at_rest:
|
|
2478
|
+
type: boolean
|
|
2479
|
+
metadata:
|
|
2480
|
+
type: array
|
|
2481
|
+
items: {}
|
|
2482
|
+
recipients:
|
|
2483
|
+
type: array
|
|
2484
|
+
items:
|
|
2485
|
+
allOf:
|
|
2486
|
+
- $ref: '#/components/schemas/PackageRecipient'
|
|
2487
|
+
- type: object
|
|
2488
|
+
properties:
|
|
2489
|
+
primaryText:
|
|
2490
|
+
type: string
|
|
2491
|
+
bcc_recipients:
|
|
2492
|
+
type: array
|
|
2493
|
+
items:
|
|
2494
|
+
$ref: '#/components/schemas/PackageRecipient'
|
|
2495
|
+
upload_notification_recipients:
|
|
2496
|
+
type: array
|
|
2497
|
+
items:
|
|
2498
|
+
$ref: '#/components/schemas/PackageRecipient'
|
|
2499
|
+
download_notification_recipients:
|
|
2500
|
+
type: array
|
|
2501
|
+
items:
|
|
2502
|
+
$ref: '#/components/schemas/PackageRecipient'
|
|
2503
|
+
additionalProperties: false
|
|
2504
|
+
PackageTransferData:
|
|
2505
|
+
description: Data of a `package_transfer` action. `timeout` is in milliseconds. Conditions work as for `transfer`.
|
|
2506
|
+
type: object
|
|
2507
|
+
properties:
|
|
2508
|
+
timeout:
|
|
2509
|
+
type:
|
|
2510
|
+
- integer
|
|
2511
|
+
- 'null'
|
|
2512
|
+
source:
|
|
2513
|
+
type: object
|
|
2514
|
+
description: Source of the package. `type`, `node_id`, `file_id` and `paths` are required; `node_id` and `file_id` are null for "same as trigger".
|
|
2515
|
+
properties:
|
|
2516
|
+
type:
|
|
2517
|
+
type: string
|
|
2518
|
+
enum:
|
|
2519
|
+
- node
|
|
2520
|
+
- workspace
|
|
2521
|
+
node_id:
|
|
2522
|
+
type:
|
|
2523
|
+
- string
|
|
2524
|
+
- 'null'
|
|
2525
|
+
pattern: ^[0-9]+$
|
|
2526
|
+
file_id:
|
|
2527
|
+
type:
|
|
2528
|
+
- string
|
|
2529
|
+
- 'null'
|
|
2530
|
+
node_name:
|
|
2531
|
+
type: string
|
|
2532
|
+
file_name:
|
|
2533
|
+
type: string
|
|
2534
|
+
workspace_id:
|
|
2535
|
+
type: string
|
|
2536
|
+
workspace_name:
|
|
2537
|
+
type: string
|
|
2538
|
+
paths:
|
|
2539
|
+
type: array
|
|
2540
|
+
items:
|
|
2541
|
+
$ref: '#/components/schemas/Paths'
|
|
2542
|
+
token:
|
|
2543
|
+
type: string
|
|
2544
|
+
access_key:
|
|
2545
|
+
type:
|
|
2546
|
+
- string
|
|
2547
|
+
- 'null'
|
|
2548
|
+
node_url:
|
|
2549
|
+
type: string
|
|
2550
|
+
required:
|
|
2551
|
+
- type
|
|
2552
|
+
- node_id
|
|
2553
|
+
- file_id
|
|
2554
|
+
- paths
|
|
2555
|
+
additionalProperties: false
|
|
2556
|
+
package:
|
|
2557
|
+
$ref: '#/components/schemas/PackageDefinition'
|
|
2558
|
+
target_rate:
|
|
2559
|
+
$ref: '#/components/schemas/TargetRate'
|
|
2560
|
+
content_encryption:
|
|
2561
|
+
type: object
|
|
2562
|
+
properties:
|
|
2563
|
+
encryption:
|
|
2564
|
+
type: string
|
|
2565
|
+
apply_protection:
|
|
2566
|
+
type: boolean
|
|
2567
|
+
password:
|
|
2568
|
+
type:
|
|
2569
|
+
- string
|
|
2570
|
+
- 'null'
|
|
2571
|
+
additionalProperties: false
|
|
2572
|
+
resume_policy:
|
|
2573
|
+
type: object
|
|
2574
|
+
properties:
|
|
2575
|
+
resume_partials:
|
|
2576
|
+
type: boolean
|
|
2577
|
+
allow_retry:
|
|
2578
|
+
type: boolean
|
|
2579
|
+
difference_check:
|
|
2580
|
+
type: string
|
|
2581
|
+
enum:
|
|
2582
|
+
- attrs
|
|
2583
|
+
- none
|
|
2584
|
+
additionalProperties: false
|
|
2585
|
+
file_attributes:
|
|
2586
|
+
type: boolean
|
|
2587
|
+
source_archive:
|
|
2588
|
+
type: object
|
|
2589
|
+
properties:
|
|
2590
|
+
archive_option:
|
|
2591
|
+
type: string
|
|
2592
|
+
enum:
|
|
2593
|
+
- delete
|
|
2594
|
+
- archive
|
|
2595
|
+
- none
|
|
2596
|
+
additionalProperties: false
|
|
2597
|
+
conditions_type:
|
|
2598
|
+
type: string
|
|
2599
|
+
enum:
|
|
2600
|
+
- all_new
|
|
2601
|
+
- custom
|
|
2602
|
+
join_type:
|
|
2603
|
+
type: string
|
|
2604
|
+
enum:
|
|
2605
|
+
- and
|
|
2606
|
+
- or
|
|
2607
|
+
conditions:
|
|
2608
|
+
type: array
|
|
2609
|
+
items:
|
|
2610
|
+
$ref: '#/components/schemas/Conditions'
|
|
2611
|
+
substitutions:
|
|
2612
|
+
type: array
|
|
2613
|
+
items:
|
|
2614
|
+
$ref: '#/components/schemas/substitutionVariables'
|
|
2615
|
+
required:
|
|
2616
|
+
- source
|
|
2617
|
+
- package
|
|
2618
|
+
additionalProperties: false
|
|
2619
|
+
ApiAuthentication:
|
|
2620
|
+
description: Authentication of the request. `bearer` requires `token`; `basic` requires `username` and `password`. The secrets are not returned.
|
|
2621
|
+
type: object
|
|
2622
|
+
properties:
|
|
2623
|
+
type:
|
|
2624
|
+
type: string
|
|
2625
|
+
enum:
|
|
2626
|
+
- none
|
|
2627
|
+
- bearer
|
|
2628
|
+
- basic
|
|
2629
|
+
default: none
|
|
2630
|
+
token:
|
|
2631
|
+
type:
|
|
2632
|
+
- string
|
|
2633
|
+
- 'null'
|
|
2634
|
+
username:
|
|
2635
|
+
type:
|
|
2636
|
+
- string
|
|
2637
|
+
- 'null'
|
|
2638
|
+
password:
|
|
2639
|
+
type:
|
|
2640
|
+
- string
|
|
2641
|
+
- 'null'
|
|
2642
|
+
required:
|
|
2643
|
+
- type
|
|
2644
|
+
additionalProperties: false
|
|
2645
|
+
ApiData:
|
|
2646
|
+
description: 'Data of an `api` action. `endpoint` must be an HTTP or HTTPS URL. `timeout` is in milliseconds: 300000 (5 min) when omitted.'
|
|
2647
|
+
type: object
|
|
2648
|
+
properties:
|
|
2649
|
+
timeout:
|
|
2650
|
+
type:
|
|
2651
|
+
- integer
|
|
2652
|
+
- 'null'
|
|
2653
|
+
method:
|
|
2654
|
+
type: string
|
|
2655
|
+
enum:
|
|
2656
|
+
- get
|
|
2657
|
+
- post
|
|
2658
|
+
- put
|
|
2659
|
+
- delete
|
|
2660
|
+
endpoint:
|
|
2661
|
+
type: string
|
|
2662
|
+
examples:
|
|
2663
|
+
- https://api.example.com/v1/ingest
|
|
2664
|
+
headers:
|
|
2665
|
+
type: array
|
|
2666
|
+
items:
|
|
2667
|
+
$ref: '#/components/schemas/Headers'
|
|
2668
|
+
authentication:
|
|
2669
|
+
$ref: '#/components/schemas/ApiAuthentication'
|
|
2670
|
+
payload:
|
|
2671
|
+
type:
|
|
2672
|
+
- string
|
|
2673
|
+
- 'null'
|
|
2674
|
+
callback:
|
|
2675
|
+
description: Wait for the callback on /external/api_callback
|
|
2676
|
+
type: boolean
|
|
2677
|
+
verify_ssl:
|
|
2678
|
+
type: boolean
|
|
2679
|
+
srs_action:
|
|
2680
|
+
type: boolean
|
|
2681
|
+
substitutions:
|
|
2682
|
+
type: array
|
|
2683
|
+
items:
|
|
2684
|
+
$ref: '#/components/schemas/substitutionVariables'
|
|
2685
|
+
required:
|
|
2686
|
+
- method
|
|
2687
|
+
- endpoint
|
|
2688
|
+
additionalProperties: false
|
|
2689
|
+
EmailNotificationData:
|
|
2690
|
+
description: Data of an `email_notification` action. `email_addresses` or `recipient_hashes` is required. `timeout` is in milliseconds, 300000 (5 min) when omitted.
|
|
2691
|
+
type: object
|
|
2692
|
+
properties:
|
|
2693
|
+
timeout:
|
|
2694
|
+
type:
|
|
2695
|
+
- integer
|
|
2696
|
+
- 'null'
|
|
2697
|
+
subject:
|
|
2698
|
+
type:
|
|
2699
|
+
- string
|
|
2700
|
+
- 'null'
|
|
2701
|
+
message:
|
|
2702
|
+
type:
|
|
2703
|
+
- string
|
|
2704
|
+
- 'null'
|
|
2705
|
+
send_as_type:
|
|
2706
|
+
description: Only `User` is accepted.
|
|
2707
|
+
type:
|
|
2708
|
+
- string
|
|
2709
|
+
- 'null'
|
|
2710
|
+
enum:
|
|
2711
|
+
- User
|
|
2712
|
+
- null
|
|
2713
|
+
email_addresses:
|
|
2714
|
+
type: array
|
|
2715
|
+
items:
|
|
2716
|
+
type: string
|
|
2717
|
+
recipient_hashes:
|
|
2718
|
+
type: array
|
|
2719
|
+
items:
|
|
2720
|
+
$ref: '#/components/schemas/RecipientHash'
|
|
2721
|
+
substitutions:
|
|
2722
|
+
type: array
|
|
2723
|
+
items:
|
|
2724
|
+
$ref: '#/components/schemas/substitutionVariables'
|
|
2725
|
+
additionalProperties: false
|
|
2726
|
+
CustomVarData:
|
|
2727
|
+
description: Data of a `custom_var` action. The action cannot be in the first step. Variable names cannot contain spaces. The value of a variable comes from a substitution whose `path` targets it.
|
|
2728
|
+
type: object
|
|
2729
|
+
properties:
|
|
2730
|
+
timeout:
|
|
2731
|
+
type:
|
|
2732
|
+
- integer
|
|
2733
|
+
- 'null'
|
|
2734
|
+
custom_variables:
|
|
2735
|
+
type: object
|
|
2736
|
+
additionalProperties: true
|
|
2737
|
+
examples:
|
|
2738
|
+
- year: string
|
|
2739
|
+
substitutions:
|
|
2740
|
+
type: array
|
|
2741
|
+
items:
|
|
2742
|
+
$ref: '#/components/schemas/substitutionVariables'
|
|
2743
|
+
required:
|
|
2744
|
+
- custom_variables
|
|
2745
|
+
- substitutions
|
|
2746
|
+
additionalProperties: false
|
|
2747
|
+
FolderData:
|
|
2748
|
+
description: Data of a `folder` action. If `folder_name` is null, a substitution must target `folder_name`. `timeout` is in milliseconds, 86400000 (24 h) when omitted.
|
|
2749
|
+
type: object
|
|
2750
|
+
properties:
|
|
2751
|
+
timeout:
|
|
2752
|
+
type:
|
|
2753
|
+
- integer
|
|
2754
|
+
- 'null'
|
|
2755
|
+
mount_point:
|
|
2756
|
+
type: boolean
|
|
2757
|
+
folder_name:
|
|
2758
|
+
type:
|
|
2759
|
+
- string
|
|
2760
|
+
- 'null'
|
|
2761
|
+
examples:
|
|
2762
|
+
- '{{workflow_instance.launched_at.YYYY}}-{{workflow_instance.launched_at.MM}}'
|
|
2763
|
+
parent_folder:
|
|
2764
|
+
type: object
|
|
2765
|
+
description: Parent folder. `type`, `node_id`, `file_id` and `paths` are required.
|
|
2766
|
+
properties:
|
|
2767
|
+
type:
|
|
2768
|
+
type: string
|
|
2769
|
+
enum:
|
|
2770
|
+
- node
|
|
2771
|
+
- workspace
|
|
2772
|
+
node_id:
|
|
2773
|
+
type: string
|
|
2774
|
+
pattern: ^[0-9]+$
|
|
2775
|
+
file_id:
|
|
2776
|
+
type: string
|
|
2777
|
+
node_name:
|
|
2778
|
+
type: string
|
|
2779
|
+
file_name:
|
|
2780
|
+
type: string
|
|
2781
|
+
workspace_id:
|
|
2782
|
+
type: string
|
|
2783
|
+
workspace_name:
|
|
2784
|
+
type: string
|
|
2785
|
+
paths:
|
|
2786
|
+
type: array
|
|
2787
|
+
items: {}
|
|
2788
|
+
token:
|
|
2789
|
+
type: string
|
|
2790
|
+
required:
|
|
2791
|
+
- type
|
|
2792
|
+
- node_id
|
|
2793
|
+
- file_id
|
|
2794
|
+
- paths
|
|
2795
|
+
additionalProperties: false
|
|
2796
|
+
substitutions:
|
|
2797
|
+
type: array
|
|
2798
|
+
items:
|
|
2799
|
+
$ref: '#/components/schemas/substitutionVariables'
|
|
2800
|
+
required:
|
|
2801
|
+
- folder_name
|
|
2802
|
+
- parent_folder
|
|
2803
|
+
additionalProperties: false
|
|
2804
|
+
ManualData:
|
|
2805
|
+
description: Data of a `manual` trigger. Send `{}`, or omit it.
|
|
2806
|
+
type: object
|
|
2807
|
+
additionalProperties: true
|
|
2808
|
+
ScheduledData:
|
|
2809
|
+
description: |-
|
|
2810
|
+
Data of a `scheduled` trigger. `start_date` (and `end_date`) must be in the future, and `start_date` before `end_date`.
|
|
2811
|
+
|
|
2812
|
+
Rules on `repeat_number`: `minutes` greater than 4; `hours` 1 to 24; `days` 1 to 7; `weeks` 1 to 4, with `days_of_the_week`; `months` 1 to 12, with `day_of_the_month` (1 to 31).
|
|
2813
|
+
type: object
|
|
2814
|
+
properties:
|
|
2815
|
+
repeat_interval:
|
|
2816
|
+
type: object
|
|
2817
|
+
properties:
|
|
2818
|
+
repeat_type:
|
|
2819
|
+
type: string
|
|
2820
|
+
enum:
|
|
2821
|
+
- minutes
|
|
2822
|
+
- hours
|
|
2823
|
+
- days
|
|
2824
|
+
- weeks
|
|
2825
|
+
- months
|
|
2826
|
+
repeat_number:
|
|
2827
|
+
type: integer
|
|
2828
|
+
days_of_the_week:
|
|
2829
|
+
description: Boolean flags by day name (`monday` to `sunday`). Required for `weeks`.
|
|
2830
|
+
type: object
|
|
2831
|
+
additionalProperties:
|
|
2832
|
+
type: boolean
|
|
2833
|
+
day_of_the_month:
|
|
2834
|
+
type: integer
|
|
2835
|
+
minimum: 1
|
|
2836
|
+
maximum: 31
|
|
2837
|
+
required:
|
|
2838
|
+
- repeat_type
|
|
2839
|
+
- repeat_number
|
|
2840
|
+
additionalProperties: false
|
|
2841
|
+
start_date:
|
|
2842
|
+
type: string
|
|
2843
|
+
format: date-time
|
|
2844
|
+
end_date:
|
|
2845
|
+
type: string
|
|
2846
|
+
format: date-time
|
|
2847
|
+
substitutions:
|
|
2848
|
+
type: array
|
|
2849
|
+
items:
|
|
2850
|
+
$ref: '#/components/schemas/substitutionVariables'
|
|
2851
|
+
required:
|
|
2852
|
+
- repeat_interval
|
|
2853
|
+
- start_date
|
|
2854
|
+
additionalProperties: false
|
|
2855
|
+
WatchFolderData:
|
|
2856
|
+
description: Data of a `watch_folder` trigger. With `conditions_type` `custom`, `join_type` and at least one condition are required; with `all_new`, there are no conditions and no `join_type`. The API adds `source.absolute_path`.
|
|
2857
|
+
type: object
|
|
2858
|
+
properties:
|
|
2859
|
+
source:
|
|
2860
|
+
type: object
|
|
2861
|
+
description: 'Monitored folder. Required: `type`, `node_id`, `node_name`, `file_id`, `file_name`, `paths` (at least one item) and `absolute_path`; for a `workspace` also `workspace_id` and `workspace_name`.'
|
|
2862
|
+
properties:
|
|
2863
|
+
type:
|
|
2864
|
+
type: string
|
|
2865
|
+
enum:
|
|
2866
|
+
- node
|
|
2867
|
+
- workspace
|
|
2868
|
+
node_id:
|
|
2869
|
+
type: string
|
|
2870
|
+
pattern: ^[0-9]+$
|
|
2871
|
+
node_name:
|
|
2872
|
+
type: string
|
|
2873
|
+
file_id:
|
|
2874
|
+
type: string
|
|
2875
|
+
file_name:
|
|
2876
|
+
type: string
|
|
2877
|
+
absolute_path:
|
|
2878
|
+
type: string
|
|
2879
|
+
workspace_id:
|
|
2880
|
+
type: string
|
|
2881
|
+
workspace_name:
|
|
2882
|
+
type: string
|
|
2883
|
+
paths:
|
|
2884
|
+
type: array
|
|
2885
|
+
minItems: 1
|
|
2886
|
+
items:
|
|
2887
|
+
$ref: '#/components/schemas/Paths'
|
|
2888
|
+
token:
|
|
2889
|
+
type: string
|
|
2890
|
+
node_url:
|
|
2891
|
+
type: string
|
|
2892
|
+
required:
|
|
2893
|
+
- type
|
|
2894
|
+
- node_id
|
|
2895
|
+
- node_name
|
|
2896
|
+
- file_id
|
|
2897
|
+
- file_name
|
|
2898
|
+
- paths
|
|
2899
|
+
additionalProperties: false
|
|
2900
|
+
recursive_trigger:
|
|
2901
|
+
type: boolean
|
|
2902
|
+
conditions_type:
|
|
2903
|
+
type: string
|
|
2904
|
+
enum:
|
|
2905
|
+
- all_new
|
|
2906
|
+
- custom
|
|
2907
|
+
join_type:
|
|
2908
|
+
type: string
|
|
2909
|
+
enum:
|
|
2910
|
+
- and
|
|
2911
|
+
- or
|
|
2912
|
+
conditions:
|
|
2913
|
+
type: array
|
|
2914
|
+
items:
|
|
2915
|
+
$ref: '#/components/schemas/Conditions'
|
|
2916
|
+
substitutions:
|
|
2917
|
+
type: array
|
|
2918
|
+
items:
|
|
2919
|
+
$ref: '#/components/schemas/substitutionVariables'
|
|
2920
|
+
required:
|
|
2921
|
+
- source
|
|
2922
|
+
additionalProperties: false
|
|
2923
|
+
SharedInboxData:
|
|
2924
|
+
description: Data of a `shared_inbox` trigger. With `conditions_type` `custom`, `join_type` and at least one condition are required.
|
|
2925
|
+
type: object
|
|
2926
|
+
properties:
|
|
2927
|
+
source:
|
|
2928
|
+
type: object
|
|
2929
|
+
properties:
|
|
2930
|
+
type:
|
|
2931
|
+
type: string
|
|
2932
|
+
enum:
|
|
2933
|
+
- workspace
|
|
2934
|
+
workspace_id:
|
|
2935
|
+
type: string
|
|
2936
|
+
workspace_name:
|
|
2937
|
+
type: string
|
|
2938
|
+
inbox_id:
|
|
2939
|
+
description: The `dropbox_id` of the shared inbox
|
|
2940
|
+
type: string
|
|
2941
|
+
inbox_name:
|
|
2942
|
+
type: string
|
|
2943
|
+
required:
|
|
2944
|
+
- type
|
|
2945
|
+
- workspace_id
|
|
2946
|
+
- workspace_name
|
|
2947
|
+
- inbox_id
|
|
2948
|
+
- inbox_name
|
|
2949
|
+
additionalProperties: false
|
|
2950
|
+
conditions_type:
|
|
2951
|
+
type: string
|
|
2952
|
+
enum:
|
|
2953
|
+
- all_new
|
|
2954
|
+
- custom
|
|
2955
|
+
join_type:
|
|
2956
|
+
type: string
|
|
2957
|
+
enum:
|
|
2958
|
+
- and
|
|
2959
|
+
- or
|
|
2960
|
+
conditions:
|
|
2961
|
+
type: array
|
|
2962
|
+
items:
|
|
2963
|
+
$ref: '#/components/schemas/SharedInboxCondition'
|
|
2964
|
+
substitutions:
|
|
2965
|
+
type: array
|
|
2966
|
+
items:
|
|
2967
|
+
$ref: '#/components/schemas/substitutionVariables'
|
|
2968
|
+
required:
|
|
2969
|
+
- source
|
|
2970
|
+
- conditions_type
|
|
2971
|
+
additionalProperties: false
|
|
2972
|
+
DeleteFolderData:
|
|
2973
|
+
description: Data of a `delete_folder` trigger. `trigger_on_file_deletes` and `trigger_on_folder_deletes` cannot be set with `conditions_type` `custom`.
|
|
2974
|
+
type: object
|
|
2975
|
+
properties:
|
|
2976
|
+
source:
|
|
2977
|
+
type: object
|
|
2978
|
+
description: 'Monitored folder. Required: `type`, `file_id`, `paths` and `access_key`.'
|
|
2979
|
+
properties:
|
|
2980
|
+
type:
|
|
2981
|
+
type: string
|
|
2982
|
+
enum:
|
|
2983
|
+
- node
|
|
2984
|
+
- workspace
|
|
2985
|
+
node_id:
|
|
2986
|
+
type: string
|
|
2987
|
+
pattern: ^[0-9]+$
|
|
2988
|
+
node_name:
|
|
2989
|
+
type: string
|
|
2990
|
+
file_id:
|
|
2991
|
+
type: string
|
|
2992
|
+
file_name:
|
|
2993
|
+
type: string
|
|
2994
|
+
workspace_id:
|
|
2995
|
+
type: string
|
|
2996
|
+
workspace_name:
|
|
2997
|
+
type: string
|
|
2998
|
+
paths:
|
|
2999
|
+
type: array
|
|
3000
|
+
items:
|
|
3001
|
+
$ref: '#/components/schemas/Paths'
|
|
3002
|
+
token:
|
|
3003
|
+
type: string
|
|
3004
|
+
access_key:
|
|
3005
|
+
type: string
|
|
3006
|
+
node_url:
|
|
3007
|
+
type: string
|
|
3008
|
+
required:
|
|
3009
|
+
- type
|
|
3010
|
+
- file_id
|
|
3011
|
+
- paths
|
|
3012
|
+
- access_key
|
|
3013
|
+
additionalProperties: false
|
|
3014
|
+
trigger_on_folder_deletes:
|
|
3015
|
+
type: boolean
|
|
3016
|
+
trigger_on_file_deletes:
|
|
3017
|
+
type: boolean
|
|
3018
|
+
conditions_type:
|
|
3019
|
+
type: string
|
|
3020
|
+
enum:
|
|
3021
|
+
- all_new
|
|
3022
|
+
- custom
|
|
3023
|
+
join_type:
|
|
3024
|
+
type: string
|
|
3025
|
+
enum:
|
|
3026
|
+
- and
|
|
3027
|
+
- or
|
|
3028
|
+
conditions:
|
|
3029
|
+
type: array
|
|
3030
|
+
items:
|
|
3031
|
+
$ref: '#/components/schemas/Conditions'
|
|
3032
|
+
substitutions:
|
|
3033
|
+
type: array
|
|
3034
|
+
items:
|
|
3035
|
+
$ref: '#/components/schemas/substitutionVariables'
|
|
3036
|
+
required:
|
|
3037
|
+
- source
|
|
3038
|
+
- conditions_type
|
|
3039
|
+
additionalProperties: false
|
|
3040
|
+
TelestreamQcData:
|
|
3041
|
+
description: Data of a `telestream_qc` action, offered only when the feature is enabled for the organization. `timeout` is in milliseconds.
|
|
3042
|
+
type: object
|
|
3043
|
+
properties:
|
|
3044
|
+
endpoint:
|
|
3045
|
+
type: string
|
|
3046
|
+
api_key:
|
|
3047
|
+
type: string
|
|
3048
|
+
body:
|
|
3049
|
+
type: string
|
|
3050
|
+
timeout:
|
|
3051
|
+
type:
|
|
3052
|
+
- integer
|
|
3053
|
+
- 'null'
|
|
3054
|
+
substitutions:
|
|
3055
|
+
type: array
|
|
3056
|
+
items:
|
|
3057
|
+
$ref: '#/components/schemas/substitutionVariables'
|
|
3058
|
+
required:
|
|
3059
|
+
- endpoint
|
|
3060
|
+
- api_key
|
|
3061
|
+
- body
|
|
3062
|
+
AntivirusData:
|
|
3063
|
+
description: Data of an `antivirus` action. The action is created by the system, not by a user.
|
|
3064
|
+
type: object
|
|
3065
|
+
properties:
|
|
3066
|
+
package_id:
|
|
3067
|
+
type: string
|
|
3068
|
+
package_contents_path:
|
|
3069
|
+
type: string
|
|
3070
|
+
file_count:
|
|
3071
|
+
type: integer
|
|
3072
|
+
node_id:
|
|
3073
|
+
type: integer
|
|
3074
|
+
file_id:
|
|
3075
|
+
type:
|
|
3076
|
+
- string
|
|
3077
|
+
- 'null'
|
|
3078
|
+
contents_file_id:
|
|
3079
|
+
type:
|
|
3080
|
+
- string
|
|
3081
|
+
- 'null'
|
|
3082
|
+
sender_id:
|
|
3083
|
+
type:
|
|
3084
|
+
- string
|
|
3085
|
+
- 'null'
|
|
3086
|
+
required:
|
|
3087
|
+
- package_id
|
|
3088
|
+
- package_contents_path
|
|
3089
|
+
- file_count
|
|
3090
|
+
- node_id
|
|
3091
|
+
additionalProperties: false
|
|
3092
|
+
createActionManual:
|
|
3093
|
+
title: Creates a manual trigger
|
|
3094
|
+
type: object
|
|
3095
|
+
properties:
|
|
3096
|
+
type:
|
|
3097
|
+
type: string
|
|
3098
|
+
enum:
|
|
3099
|
+
- manual
|
|
3100
|
+
step_id:
|
|
3101
|
+
type: string
|
|
2266
3102
|
name:
|
|
2267
|
-
description: Name of recipient
|
|
2268
3103
|
type: string
|
|
2269
|
-
|
|
2270
|
-
|
|
3104
|
+
data:
|
|
3105
|
+
$ref: '#/components/schemas/ManualData'
|
|
2271
3106
|
required:
|
|
2272
|
-
- id
|
|
2273
3107
|
- type
|
|
2274
|
-
|
|
2275
|
-
|
|
3108
|
+
- step_id
|
|
3109
|
+
createActionScheduled:
|
|
3110
|
+
title: Creates a scheduled trigger
|
|
2276
3111
|
type: object
|
|
2277
3112
|
properties:
|
|
2278
|
-
|
|
2279
|
-
description: Recipient ID
|
|
3113
|
+
type:
|
|
2280
3114
|
type: string
|
|
2281
|
-
|
|
2282
|
-
-
|
|
3115
|
+
enum:
|
|
3116
|
+
- scheduled
|
|
3117
|
+
step_id:
|
|
3118
|
+
type: string
|
|
3119
|
+
name:
|
|
3120
|
+
type: string
|
|
3121
|
+
data:
|
|
3122
|
+
$ref: '#/components/schemas/ScheduledData'
|
|
3123
|
+
required:
|
|
3124
|
+
- type
|
|
3125
|
+
- step_id
|
|
3126
|
+
- data
|
|
3127
|
+
createActionWatchFolder:
|
|
3128
|
+
title: Creates a watch folder trigger
|
|
3129
|
+
type: object
|
|
3130
|
+
properties:
|
|
2283
3131
|
type:
|
|
2284
|
-
description: 'User type of recipient.'
|
|
2285
3132
|
type: string
|
|
2286
|
-
examples:
|
|
2287
|
-
- admin
|
|
2288
3133
|
enum:
|
|
2289
|
-
-
|
|
2290
|
-
|
|
3134
|
+
- watch_folder
|
|
3135
|
+
step_id:
|
|
3136
|
+
type: string
|
|
2291
3137
|
name:
|
|
2292
|
-
description: Name of recipient
|
|
2293
3138
|
type: string
|
|
2294
|
-
|
|
2295
|
-
|
|
3139
|
+
data:
|
|
3140
|
+
$ref: '#/components/schemas/WatchFolderData'
|
|
2296
3141
|
required:
|
|
2297
|
-
- id
|
|
2298
3142
|
- type
|
|
2299
|
-
|
|
2300
|
-
|
|
3143
|
+
- step_id
|
|
3144
|
+
- data
|
|
3145
|
+
createActionSharedInbox:
|
|
3146
|
+
title: Creates a shared inbox trigger
|
|
2301
3147
|
type: object
|
|
2302
3148
|
properties:
|
|
2303
|
-
|
|
2304
|
-
description: Recipient ID
|
|
3149
|
+
type:
|
|
2305
3150
|
type: string
|
|
2306
|
-
|
|
2307
|
-
-
|
|
3151
|
+
enum:
|
|
3152
|
+
- shared_inbox
|
|
3153
|
+
step_id:
|
|
3154
|
+
type: string
|
|
3155
|
+
name:
|
|
3156
|
+
type: string
|
|
3157
|
+
data:
|
|
3158
|
+
$ref: '#/components/schemas/SharedInboxData'
|
|
3159
|
+
required:
|
|
3160
|
+
- type
|
|
3161
|
+
- step_id
|
|
3162
|
+
- data
|
|
3163
|
+
createActionDeleteFolder:
|
|
3164
|
+
title: Creates a delete folder trigger
|
|
3165
|
+
type: object
|
|
3166
|
+
properties:
|
|
2308
3167
|
type:
|
|
2309
|
-
description: 'User type of recipient.'
|
|
2310
3168
|
type: string
|
|
2311
|
-
examples:
|
|
2312
|
-
- admin
|
|
2313
3169
|
enum:
|
|
2314
|
-
-
|
|
2315
|
-
|
|
3170
|
+
- delete_folder
|
|
3171
|
+
step_id:
|
|
3172
|
+
type: string
|
|
2316
3173
|
name:
|
|
2317
|
-
description: Name of recipient
|
|
2318
3174
|
type: string
|
|
2319
|
-
|
|
2320
|
-
|
|
3175
|
+
data:
|
|
3176
|
+
$ref: '#/components/schemas/DeleteFolderData'
|
|
2321
3177
|
required:
|
|
2322
|
-
- id
|
|
2323
3178
|
- type
|
|
2324
|
-
|
|
2325
|
-
|
|
3179
|
+
- step_id
|
|
3180
|
+
- data
|
|
3181
|
+
createActionTransfer:
|
|
3182
|
+
title: Creates a new action to send a file or folder
|
|
2326
3183
|
type: object
|
|
2327
3184
|
properties:
|
|
2328
|
-
|
|
2329
|
-
description:
|
|
3185
|
+
type:
|
|
3186
|
+
description: Action type. For an action that transfers a file, the type is always transfer.
|
|
3187
|
+
type: string
|
|
3188
|
+
enum:
|
|
3189
|
+
- transfer
|
|
3190
|
+
step_id:
|
|
3191
|
+
description: ID for step that contains the action
|
|
2330
3192
|
type: string
|
|
2331
3193
|
examples:
|
|
2332
|
-
- '
|
|
3194
|
+
- '1314'
|
|
3195
|
+
name:
|
|
3196
|
+
type: string
|
|
3197
|
+
data:
|
|
3198
|
+
$ref: '#/components/schemas/TransferData'
|
|
3199
|
+
required:
|
|
3200
|
+
- type
|
|
3201
|
+
- step_id
|
|
3202
|
+
- data
|
|
3203
|
+
createActionPackageTransfer:
|
|
3204
|
+
title: Creates a new action to send a package
|
|
3205
|
+
type: object
|
|
3206
|
+
properties:
|
|
2333
3207
|
type:
|
|
2334
|
-
description: 'User type of recipient.'
|
|
2335
3208
|
type: string
|
|
2336
|
-
examples:
|
|
2337
|
-
- user
|
|
2338
3209
|
enum:
|
|
2339
|
-
-
|
|
2340
|
-
|
|
3210
|
+
- package_transfer
|
|
3211
|
+
step_id:
|
|
3212
|
+
type: string
|
|
2341
3213
|
name:
|
|
2342
|
-
description: Name of recipient
|
|
2343
3214
|
type: string
|
|
2344
|
-
|
|
2345
|
-
|
|
3215
|
+
data:
|
|
3216
|
+
$ref: '#/components/schemas/PackageTransferData'
|
|
2346
3217
|
required:
|
|
2347
|
-
- id
|
|
2348
3218
|
- type
|
|
2349
|
-
|
|
2350
|
-
|
|
3219
|
+
- step_id
|
|
3220
|
+
- data
|
|
3221
|
+
createActionAPI:
|
|
3222
|
+
title: Creates a new action that calls an API
|
|
2351
3223
|
type: object
|
|
2352
3224
|
properties:
|
|
2353
|
-
|
|
2354
|
-
description:
|
|
3225
|
+
type:
|
|
3226
|
+
description: Action type. For an action that calls an API, the type is always api.
|
|
3227
|
+
type: string
|
|
3228
|
+
enum:
|
|
3229
|
+
- api
|
|
3230
|
+
step_id:
|
|
3231
|
+
description: ID of step that contains the action
|
|
2355
3232
|
type: string
|
|
2356
3233
|
examples:
|
|
2357
|
-
-
|
|
3234
|
+
- '1406'
|
|
3235
|
+
name:
|
|
3236
|
+
type: string
|
|
3237
|
+
data:
|
|
3238
|
+
$ref: '#/components/schemas/ApiData'
|
|
2358
3239
|
required:
|
|
2359
|
-
-
|
|
2360
|
-
|
|
2361
|
-
|
|
3240
|
+
- type
|
|
3241
|
+
- step_id
|
|
3242
|
+
- data
|
|
3243
|
+
createActionEmailNotification:
|
|
3244
|
+
title: Creates a new action that sends an email
|
|
2362
3245
|
type: object
|
|
2363
3246
|
properties:
|
|
2364
|
-
|
|
2365
|
-
description: 'Request a state change. 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.'
|
|
3247
|
+
type:
|
|
2366
3248
|
type: string
|
|
2367
|
-
examples:
|
|
2368
|
-
- save_as_draft
|
|
2369
3249
|
enum:
|
|
2370
|
-
-
|
|
2371
|
-
|
|
2372
|
-
|
|
3250
|
+
- email_notification
|
|
3251
|
+
step_id:
|
|
3252
|
+
type: string
|
|
3253
|
+
name:
|
|
3254
|
+
type: string
|
|
3255
|
+
data:
|
|
3256
|
+
$ref: '#/components/schemas/EmailNotificationData'
|
|
2373
3257
|
required:
|
|
2374
|
-
-
|
|
2375
|
-
|
|
2376
|
-
|
|
3258
|
+
- type
|
|
3259
|
+
- step_id
|
|
3260
|
+
- data
|
|
3261
|
+
createActionCustomVar:
|
|
3262
|
+
title: Creates a new action that defines custom variables
|
|
2377
3263
|
type: object
|
|
2378
3264
|
properties:
|
|
2379
|
-
|
|
2380
|
-
|
|
2381
|
-
|
|
2382
|
-
|
|
2383
|
-
|
|
2384
|
-
|
|
2385
|
-
|
|
2386
|
-
type:
|
|
2387
|
-
|
|
2388
|
-
|
|
2389
|
-
|
|
3265
|
+
type:
|
|
3266
|
+
type: string
|
|
3267
|
+
enum:
|
|
3268
|
+
- custom_var
|
|
3269
|
+
step_id:
|
|
3270
|
+
type: string
|
|
3271
|
+
name:
|
|
3272
|
+
type: string
|
|
3273
|
+
data:
|
|
3274
|
+
$ref: '#/components/schemas/CustomVarData'
|
|
3275
|
+
required:
|
|
3276
|
+
- type
|
|
3277
|
+
- step_id
|
|
3278
|
+
- data
|
|
3279
|
+
createActionFolder:
|
|
3280
|
+
title: Creates a new action that creates a folder
|
|
3281
|
+
type: object
|
|
3282
|
+
properties:
|
|
3283
|
+
type:
|
|
3284
|
+
type: string
|
|
3285
|
+
enum:
|
|
3286
|
+
- folder
|
|
3287
|
+
step_id:
|
|
3288
|
+
type: string
|
|
3289
|
+
name:
|
|
3290
|
+
type: string
|
|
3291
|
+
data:
|
|
3292
|
+
$ref: '#/components/schemas/FolderData'
|
|
3293
|
+
required:
|
|
3294
|
+
- type
|
|
3295
|
+
- step_id
|
|
3296
|
+
- data
|
|
3297
|
+
createActionTelestreamQc:
|
|
3298
|
+
title: Creates a new Telestream quality control action
|
|
3299
|
+
type: object
|
|
3300
|
+
properties:
|
|
3301
|
+
type:
|
|
3302
|
+
type: string
|
|
3303
|
+
enum:
|
|
3304
|
+
- telestream_qc
|
|
3305
|
+
step_id:
|
|
3306
|
+
type: string
|
|
3307
|
+
name:
|
|
3308
|
+
type: string
|
|
3309
|
+
data:
|
|
3310
|
+
$ref: '#/components/schemas/TelestreamQcData'
|
|
3311
|
+
required:
|
|
3312
|
+
- type
|
|
3313
|
+
- step_id
|
|
3314
|
+
- data
|
|
3315
|
+
createActionAntivirus:
|
|
3316
|
+
title: Creates an antivirus action
|
|
3317
|
+
type: object
|
|
3318
|
+
properties:
|
|
3319
|
+
type:
|
|
3320
|
+
type: string
|
|
3321
|
+
enum:
|
|
3322
|
+
- antivirus
|
|
3323
|
+
step_id:
|
|
3324
|
+
type: string
|
|
3325
|
+
name:
|
|
3326
|
+
type: string
|
|
3327
|
+
data:
|
|
3328
|
+
$ref: '#/components/schemas/AntivirusData'
|
|
3329
|
+
required:
|
|
3330
|
+
- type
|
|
3331
|
+
- step_id
|
|
3332
|
+
- data
|
|
3333
|
+
createAction:
|
|
3334
|
+
description: Request to create or update an action. The `type` selects the structure of `data`.
|
|
3335
|
+
oneOf:
|
|
3336
|
+
- $ref: '#/components/schemas/createActionManual'
|
|
3337
|
+
- $ref: '#/components/schemas/createActionScheduled'
|
|
3338
|
+
- $ref: '#/components/schemas/createActionWatchFolder'
|
|
3339
|
+
- $ref: '#/components/schemas/createActionSharedInbox'
|
|
3340
|
+
- $ref: '#/components/schemas/createActionDeleteFolder'
|
|
3341
|
+
- $ref: '#/components/schemas/createActionTransfer'
|
|
3342
|
+
- $ref: '#/components/schemas/createActionPackageTransfer'
|
|
3343
|
+
- $ref: '#/components/schemas/createActionAPI'
|
|
3344
|
+
- $ref: '#/components/schemas/createActionEmailNotification'
|
|
3345
|
+
- $ref: '#/components/schemas/createActionCustomVar'
|
|
3346
|
+
- $ref: '#/components/schemas/createActionFolder'
|
|
3347
|
+
- $ref: '#/components/schemas/createActionTelestreamQc'
|
|
3348
|
+
- $ref: '#/components/schemas/createActionAntivirus'
|
|
3349
|
+
discriminator:
|
|
3350
|
+
propertyName: type
|
|
3351
|
+
mapping:
|
|
3352
|
+
manual: '#/components/schemas/createActionManual'
|
|
3353
|
+
scheduled: '#/components/schemas/createActionScheduled'
|
|
3354
|
+
watch_folder: '#/components/schemas/createActionWatchFolder'
|
|
3355
|
+
shared_inbox: '#/components/schemas/createActionSharedInbox'
|
|
3356
|
+
delete_folder: '#/components/schemas/createActionDeleteFolder'
|
|
3357
|
+
transfer: '#/components/schemas/createActionTransfer'
|
|
3358
|
+
package_transfer: '#/components/schemas/createActionPackageTransfer'
|
|
3359
|
+
api: '#/components/schemas/createActionAPI'
|
|
3360
|
+
email_notification: '#/components/schemas/createActionEmailNotification'
|
|
3361
|
+
custom_var: '#/components/schemas/createActionCustomVar'
|
|
3362
|
+
folder: '#/components/schemas/createActionFolder'
|
|
3363
|
+
telestream_qc: '#/components/schemas/createActionTelestreamQc'
|
|
3364
|
+
antivirus: '#/components/schemas/createActionAntivirus'
|
|
2390
3365
|
securitySchemes:
|
|
2391
3366
|
bearerAuth:
|
|
2392
3367
|
type: http
|
|
2393
3368
|
scheme: bearer
|
|
2394
3369
|
bearerFormat: JWT
|
|
2395
3370
|
description: JSON Web Token (bearer token) in the Authorization header
|
|
3371
|
+
responses:
|
|
3372
|
+
Unauthorized:
|
|
3373
|
+
description: Unauthorized. The bearer token is missing or is not a valid JSON Web Token.
|
|
3374
|
+
content:
|
|
3375
|
+
application/json:
|
|
3376
|
+
schema:
|
|
3377
|
+
$ref: '#/components/schemas/Error'
|
|
3378
|
+
Forbidden:
|
|
3379
|
+
description: Forbidden. The token does not give access to the Automation application, the Automation application is not enabled for the organization, or the user has no permission on the resource.
|
|
3380
|
+
content:
|
|
3381
|
+
application/json:
|
|
3382
|
+
schema:
|
|
3383
|
+
$ref: '#/components/schemas/Error'
|
|
3384
|
+
NotFound:
|
|
3385
|
+
description: Not Found. The identifier submitted in the request is incorrect, or the resource was deleted.
|
|
3386
|
+
content:
|
|
3387
|
+
application/json:
|
|
3388
|
+
schema:
|
|
3389
|
+
$ref: '#/components/schemas/Error'
|
|
3390
|
+
UnprocessableEntity:
|
|
3391
|
+
description: Unprocessable Entity. A parameter is missing or incorrect, or the operation is not allowed in the current state. The message gives the reason.
|
|
3392
|
+
content:
|
|
3393
|
+
application/json:
|
|
3394
|
+
schema:
|
|
3395
|
+
$ref: '#/components/schemas/Error'
|