@globus/sdk 6.0.0-rc.8 → 6.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -0
- package/dist/cjs/core/authorization/index.js +19 -5
- package/dist/cjs/core/authorization/index.js.map +2 -2
- package/dist/cjs/core/info/index.js +1 -1
- package/dist/cjs/core/info/index.js.map +1 -1
- package/dist/cjs/index.js +27 -8
- package/dist/cjs/index.js.map +2 -2
- package/dist/cjs/services/globus-connect-server/client.js +2 -2
- package/dist/cjs/services/globus-connect-server/client.js.map +2 -2
- package/dist/esm/core/authorization/AuthorizationManager.d.ts +38 -5
- package/dist/esm/core/authorization/AuthorizationManager.d.ts.map +1 -1
- package/dist/esm/core/authorization/AuthorizationManager.js +37 -4
- package/dist/esm/core/authorization/AuthorizationManager.js.map +1 -1
- package/dist/esm/core/authorization/RedirectTransport.d.ts +2 -0
- package/dist/esm/core/authorization/RedirectTransport.d.ts.map +1 -1
- package/dist/esm/core/authorization/RedirectTransport.js.map +1 -1
- package/dist/esm/core/info/version.d.ts +1 -1
- package/dist/esm/core/info/version.js +1 -1
- package/dist/esm/index.d.ts +24 -2
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +24 -2
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/open-api/types/compute.d.ts +47 -21
- package/dist/esm/open-api/types/compute.d.ts.map +1 -1
- package/dist/esm/open-api/types/flows.d.ts +2623 -0
- package/dist/esm/open-api/types/flows.d.ts.map +1 -0
- package/dist/esm/open-api/types/flows.js +2 -0
- package/dist/esm/open-api/types/flows.js.map +1 -0
- package/dist/esm/open-api/types/gcs/v5.4.d.ts +1348 -1036
- package/dist/esm/open-api/types/gcs/v5.4.d.ts.map +1 -1
- package/dist/esm/open-api/types/search.d.ts +119 -11
- package/dist/esm/open-api/types/search.d.ts.map +1 -1
- package/dist/esm/open-api/types/timers.d.ts +185 -17
- package/dist/esm/open-api/types/timers.d.ts.map +1 -1
- package/dist/esm/package.json +1 -1
- package/dist/esm/services/flows/index.d.ts +1 -0
- package/dist/esm/services/flows/index.d.ts.map +1 -1
- package/dist/esm/services/flows/index.js.map +1 -1
- package/dist/esm/services/flows/service/flows.d.ts +19 -83
- package/dist/esm/services/flows/service/flows.d.ts.map +1 -1
- package/dist/esm/services/flows/service/flows.js.map +1 -1
- package/dist/esm/services/flows/service/runs.d.ts +17 -24
- package/dist/esm/services/flows/service/runs.d.ts.map +1 -1
- package/dist/esm/services/flows/service/runs.js.map +1 -1
- package/dist/esm/services/globus-connect-server/client.d.ts +55 -0
- package/dist/esm/services/globus-connect-server/client.d.ts.map +1 -1
- package/dist/esm/services/shared.js +1 -1
- package/dist/esm/services/shared.js.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts +3 -3
- package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/endpoint.d.ts +1 -0
- package/dist/esm/services/transfer/service/endpoint.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/endpoint.js.map +1 -1
- package/dist/esm/services/transfer/service/task.d.ts +3 -3
- package/dist/esm/services/transfer/service/task.d.ts.map +1 -1
- package/dist/esm/services/transfer/types.d.ts +1 -1
- package/dist/esm/services/transfer/types.d.ts.map +1 -1
- package/dist/esm/services/transfer/utils.d.ts.map +1 -1
- package/dist/esm/services/transfer/utils.js +8 -3
- package/dist/esm/services/transfer/utils.js.map +1 -1
- package/dist/esm/services/types.d.ts +4 -0
- package/dist/esm/services/types.d.ts.map +1 -1
- package/dist/umd/globus.production.js +2 -2
- package/dist/umd/globus.production.js.map +2 -2
- package/package.json +5 -5
- package/dist/esm/open-api/types/timer.d.ts +0 -942
- package/dist/esm/open-api/types/timer.d.ts.map +0 -1
- package/dist/esm/open-api/types/timer.js +0 -2
- package/dist/esm/open-api/types/timer.js.map +0 -1
- package/dist/esm/services/timer/config.d.ts +0 -4
- package/dist/esm/services/timer/config.d.ts.map +0 -1
- package/dist/esm/services/timer/config.js +0 -10
- package/dist/esm/services/timer/config.js.map +0 -1
- package/dist/esm/services/timer/index.d.ts +0 -16
- package/dist/esm/services/timer/index.d.ts.map +0 -1
- package/dist/esm/services/timer/index.js +0 -15
- package/dist/esm/services/timer/index.js.map +0 -1
- package/dist/esm/services/timer/service/timer.d.ts +0 -32
- package/dist/esm/services/timer/service/timer.d.ts.map +0 -1
- package/dist/esm/services/timer/service/timer.js +0 -11
- package/dist/esm/services/timer/service/timer.js.map +0 -1
|
@@ -0,0 +1,2623 @@
|
|
|
1
|
+
export interface paths {
|
|
2
|
+
"/flows": {
|
|
3
|
+
parameters: {
|
|
4
|
+
query?: never;
|
|
5
|
+
header?: never;
|
|
6
|
+
path?: never;
|
|
7
|
+
cookie?: never;
|
|
8
|
+
};
|
|
9
|
+
/**
|
|
10
|
+
* Retrieve all Flows
|
|
11
|
+
* @description Query the Flows service for a listing of Flows available to a user
|
|
12
|
+
* according to the permissions (role) they have on the Flow.
|
|
13
|
+
*
|
|
14
|
+
*/
|
|
15
|
+
get: {
|
|
16
|
+
parameters: {
|
|
17
|
+
query?: {
|
|
18
|
+
/** @description An opaque token used to iterate through pages of returned Flows.
|
|
19
|
+
* If provided, all other query arguments will be ignored.
|
|
20
|
+
* The marker encodes all state in a given query,
|
|
21
|
+
* therefore it's unnecessary to provide query arguments
|
|
22
|
+
* once an initial marker has been received.
|
|
23
|
+
* */
|
|
24
|
+
marker?: string;
|
|
25
|
+
/**
|
|
26
|
+
* @description The number of results to return in a single paged response.
|
|
27
|
+
*
|
|
28
|
+
* @example 50
|
|
29
|
+
*/
|
|
30
|
+
per_page?: number;
|
|
31
|
+
/**
|
|
32
|
+
* @description The page of results to return.
|
|
33
|
+
* @example 2
|
|
34
|
+
*/
|
|
35
|
+
page?: number;
|
|
36
|
+
/**
|
|
37
|
+
* @description Return Flows for which the user has the supplied role. The role the
|
|
38
|
+
* user has on the Flow dictates the operations they can perform. If
|
|
39
|
+
* multiple roles are specified, the user will have at least one of the
|
|
40
|
+
* specified roles on each Flow returned.
|
|
41
|
+
*
|
|
42
|
+
* @example [
|
|
43
|
+
* "flow_owner",
|
|
44
|
+
* "flow_viewers"
|
|
45
|
+
* ]
|
|
46
|
+
*/
|
|
47
|
+
filter_roles?: ("flow_owner" | "flow_viewers" | "flow_starters" | "flow_administrators" | "run_managers" | "run_monitors")[];
|
|
48
|
+
/**
|
|
49
|
+
* @deprecated
|
|
50
|
+
* @description Return Flows for which the user has the provided role. The
|
|
51
|
+
* role the user has on the Flow dictates the operations they
|
|
52
|
+
* can perform. Roles are cumulative in the sense that
|
|
53
|
+
* having, for example, the "flow_starter" role also implies having
|
|
54
|
+
* the "flow_viewer" role. Thus, specifying "flow_starter" will also
|
|
55
|
+
* include all Flows for which the user has "flow_viewer" role as
|
|
56
|
+
* well. If not provided, only Flows for which the caller has
|
|
57
|
+
* "flow_owner" role will be returned.
|
|
58
|
+
*
|
|
59
|
+
* @example flow_starter
|
|
60
|
+
*/
|
|
61
|
+
filter_role?: "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner" | "run_manager" | "run_monitor";
|
|
62
|
+
/**
|
|
63
|
+
* @description Performs a case insensitive substring based search on the Flows'
|
|
64
|
+
* scope string fields. If multiple values are specified, each Flow
|
|
65
|
+
* returned is guaranteed to contain at least one of the strings in its
|
|
66
|
+
* scope strings.
|
|
67
|
+
*
|
|
68
|
+
* @example [
|
|
69
|
+
* "0abc",
|
|
70
|
+
* "100"
|
|
71
|
+
* ]
|
|
72
|
+
*/
|
|
73
|
+
filter_scope_string?: string[];
|
|
74
|
+
/**
|
|
75
|
+
* @description Performs a case insensitive substring based search on the Flows' title
|
|
76
|
+
* field. If multiple values are specified, each Flow returned
|
|
77
|
+
* is guaranteed to contain at least one of the strings in its title.
|
|
78
|
+
*
|
|
79
|
+
* @example [
|
|
80
|
+
* "hello",
|
|
81
|
+
* "science"
|
|
82
|
+
* ]
|
|
83
|
+
*/
|
|
84
|
+
filter_title?: string[];
|
|
85
|
+
/**
|
|
86
|
+
* @description Performs a case insensitive substring based search on the Flows'
|
|
87
|
+
* subtitle field. If multiple values are specified, each Flow returned
|
|
88
|
+
* is guaranteed to contain at least one of the strings in its
|
|
89
|
+
* subtitle.
|
|
90
|
+
*
|
|
91
|
+
* @example [
|
|
92
|
+
* "hello",
|
|
93
|
+
* "science"
|
|
94
|
+
* ]
|
|
95
|
+
*/
|
|
96
|
+
filter_subtitle?: string[];
|
|
97
|
+
/**
|
|
98
|
+
* @description Performs a case insensitive substring based search on the Flows'
|
|
99
|
+
* description field. If multiple values are specified, each Flow returned
|
|
100
|
+
* is guaranteed to contain at least one of the strings in its
|
|
101
|
+
* description.
|
|
102
|
+
*
|
|
103
|
+
* @example [
|
|
104
|
+
* "hello",
|
|
105
|
+
* "science"
|
|
106
|
+
* ]
|
|
107
|
+
*/
|
|
108
|
+
filter_description?: string[];
|
|
109
|
+
/**
|
|
110
|
+
* @description Performs a case insensitive substring based search on the Flows'
|
|
111
|
+
* keywords field. If multiple values are specified, each Flow returned
|
|
112
|
+
* is guaranteed to contain at least one of the substrings as a
|
|
113
|
+
* keyword.
|
|
114
|
+
*
|
|
115
|
+
* @example [
|
|
116
|
+
* "hello",
|
|
117
|
+
* "science"
|
|
118
|
+
* ]
|
|
119
|
+
*/
|
|
120
|
+
filter_keywords?: string[];
|
|
121
|
+
/**
|
|
122
|
+
* @description Given a one or more patterns, this filter searches against a
|
|
123
|
+
* pre-defined subset of fields for a match. If any of the fields match
|
|
124
|
+
* any of the patterns, the Flow is considered a match.
|
|
125
|
+
*
|
|
126
|
+
* The fields that are automatically searched in are:
|
|
127
|
+
* - title
|
|
128
|
+
* - subtitle
|
|
129
|
+
* - flow_owner
|
|
130
|
+
* - description
|
|
131
|
+
* - id
|
|
132
|
+
* - flow_administrators
|
|
133
|
+
*
|
|
134
|
+
* @example [
|
|
135
|
+
* "globus"
|
|
136
|
+
* ]
|
|
137
|
+
*/
|
|
138
|
+
filter_fulltext?: string[];
|
|
139
|
+
/**
|
|
140
|
+
* @description Ordering criteria to apply to the list of flows.
|
|
141
|
+
*
|
|
142
|
+
* This field is a comma-separated list of sort criteria,
|
|
143
|
+
* and follows this syntax:
|
|
144
|
+
*
|
|
145
|
+
* ```
|
|
146
|
+
* CRITERION1[,CRITERION2[,...]]
|
|
147
|
+
* ```
|
|
148
|
+
*
|
|
149
|
+
* and each individual `CRITERION` follows this syntax:
|
|
150
|
+
*
|
|
151
|
+
* ```
|
|
152
|
+
* FIELD ORDERING
|
|
153
|
+
* ```
|
|
154
|
+
*
|
|
155
|
+
* The first value, `FIELD`, indicates the field to sort by;
|
|
156
|
+
* the second value, `ORDERING`, indicates the sorting order.
|
|
157
|
+
*
|
|
158
|
+
* When additional comma-separated criteria are added,
|
|
159
|
+
* the first criterion will be used to sort the data;
|
|
160
|
+
* subsequent criteria will be applied for ties.
|
|
161
|
+
*
|
|
162
|
+
* Supported fields are:
|
|
163
|
+
*
|
|
164
|
+
* - `id`
|
|
165
|
+
* - `scope_string`
|
|
166
|
+
* - `flow_owner`
|
|
167
|
+
* - `flow_administrators`
|
|
168
|
+
* - `title`
|
|
169
|
+
* - `created_at`
|
|
170
|
+
* - `updated_at`
|
|
171
|
+
*
|
|
172
|
+
* Supported orderings are:
|
|
173
|
+
*
|
|
174
|
+
* - `ASC`
|
|
175
|
+
* - `DESC`
|
|
176
|
+
*
|
|
177
|
+
* @example [
|
|
178
|
+
* "title ASC",
|
|
179
|
+
* "id DESC"
|
|
180
|
+
* ]
|
|
181
|
+
*/
|
|
182
|
+
orderby?: components["parameters"]["list_flows_orderby"];
|
|
183
|
+
};
|
|
184
|
+
header?: never;
|
|
185
|
+
path?: never;
|
|
186
|
+
cookie?: never;
|
|
187
|
+
};
|
|
188
|
+
requestBody?: never;
|
|
189
|
+
responses: {
|
|
190
|
+
/** @description The requestor has successfully authenticated and queried the Flow's
|
|
191
|
+
* service for the Flows available for them.
|
|
192
|
+
* */
|
|
193
|
+
200: {
|
|
194
|
+
headers: {
|
|
195
|
+
[name: string]: unknown;
|
|
196
|
+
};
|
|
197
|
+
content: {
|
|
198
|
+
"application/json": {
|
|
199
|
+
flows?: components["schemas"]["FlowResponse"][];
|
|
200
|
+
/** @description The number of Flows returned. */
|
|
201
|
+
limit?: number;
|
|
202
|
+
/** @description An opaque pagination token for iterating through returned
|
|
203
|
+
* Flows.
|
|
204
|
+
* */
|
|
205
|
+
marker?: string;
|
|
206
|
+
has_next_page?: boolean;
|
|
207
|
+
};
|
|
208
|
+
};
|
|
209
|
+
};
|
|
210
|
+
/** @description There was an issue parsing the query parameters.
|
|
211
|
+
* */
|
|
212
|
+
400: {
|
|
213
|
+
headers: {
|
|
214
|
+
[name: string]: unknown;
|
|
215
|
+
};
|
|
216
|
+
content?: never;
|
|
217
|
+
};
|
|
218
|
+
/** @description The requestor presented a token with insufficient scopes.
|
|
219
|
+
* */
|
|
220
|
+
403: {
|
|
221
|
+
headers: {
|
|
222
|
+
[name: string]: unknown;
|
|
223
|
+
};
|
|
224
|
+
content?: never;
|
|
225
|
+
};
|
|
226
|
+
};
|
|
227
|
+
};
|
|
228
|
+
put?: never;
|
|
229
|
+
/**
|
|
230
|
+
* Deploy a Flow
|
|
231
|
+
* @description Deploy a Flow and its schema.
|
|
232
|
+
*/
|
|
233
|
+
post: {
|
|
234
|
+
parameters: {
|
|
235
|
+
query?: never;
|
|
236
|
+
header?: never;
|
|
237
|
+
path?: never;
|
|
238
|
+
cookie?: never;
|
|
239
|
+
};
|
|
240
|
+
requestBody: {
|
|
241
|
+
content: {
|
|
242
|
+
"application/json": {
|
|
243
|
+
definition: components["schemas"]["FlowDefinition"];
|
|
244
|
+
/** @description A non-unique, human-friendly name used for displaying the provider
|
|
245
|
+
* to end users.
|
|
246
|
+
* */
|
|
247
|
+
title?: string;
|
|
248
|
+
/** @description A concise summary of the provider’s purpose. */
|
|
249
|
+
subtitle?: string;
|
|
250
|
+
/** @description A detailed description of the provider for end user display. */
|
|
251
|
+
description?: string;
|
|
252
|
+
/** @description A set of terms used to categorize the provider which may be used in
|
|
253
|
+
* query and discovery operations. Maximum total length of all
|
|
254
|
+
* keywords is 1024 characters.
|
|
255
|
+
* */
|
|
256
|
+
keywords?: string[];
|
|
257
|
+
/**
|
|
258
|
+
* @description A set of Principal URNs, or the value "public",
|
|
259
|
+
* indicating the identity of users and/or groups
|
|
260
|
+
* who can view the flow.
|
|
261
|
+
*
|
|
262
|
+
* @example [
|
|
263
|
+
* "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
|
|
264
|
+
* "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
|
|
265
|
+
* ]
|
|
266
|
+
*/
|
|
267
|
+
flow_viewers?: ("public" | components["schemas"]["PrincipalURN"])[];
|
|
268
|
+
/**
|
|
269
|
+
* @description A set of Principal URNs, or the value "all_authenticated_users",
|
|
270
|
+
* indicating the identity of users who can start the flow.
|
|
271
|
+
*
|
|
272
|
+
* @example [
|
|
273
|
+
* "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
|
|
274
|
+
* "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
|
|
275
|
+
* ]
|
|
276
|
+
*/
|
|
277
|
+
flow_starters?: ("all_authenticated_users" | components["schemas"]["PrincipalURN"])[];
|
|
278
|
+
/**
|
|
279
|
+
* @description The set of Principal URN values of users who may perform
|
|
280
|
+
* administrative operations, including updating the description
|
|
281
|
+
* itself, on the flow.
|
|
282
|
+
*
|
|
283
|
+
* @example [
|
|
284
|
+
* "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
|
|
285
|
+
* "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
|
|
286
|
+
* ]
|
|
287
|
+
*/
|
|
288
|
+
flow_administrators?: components["schemas"]["PrincipalURN"][];
|
|
289
|
+
/** @description A published JSON Schema which input to the Flow must conform
|
|
290
|
+
* to.
|
|
291
|
+
* */
|
|
292
|
+
input_schema?: Record<string, unknown>;
|
|
293
|
+
run_managers?: components["schemas"]["RunManagers"];
|
|
294
|
+
run_monitors?: components["schemas"]["RunMonitors"];
|
|
295
|
+
/**
|
|
296
|
+
* Format: uuid
|
|
297
|
+
* @description A subscription to associate with this flow.
|
|
298
|
+
*
|
|
299
|
+
* If no subscription is specified, the flow may be created
|
|
300
|
+
* but may have limits on how long or how much it can be used.
|
|
301
|
+
*
|
|
302
|
+
*/
|
|
303
|
+
subscription_id?: string;
|
|
304
|
+
};
|
|
305
|
+
};
|
|
306
|
+
};
|
|
307
|
+
responses: {
|
|
308
|
+
/** @description The Flow definition was successfully deployed onto the Flows
|
|
309
|
+
* service.
|
|
310
|
+
* */
|
|
311
|
+
201: {
|
|
312
|
+
headers: {
|
|
313
|
+
[name: string]: unknown;
|
|
314
|
+
};
|
|
315
|
+
content: {
|
|
316
|
+
"application/json": components["schemas"]["FlowResponse"];
|
|
317
|
+
};
|
|
318
|
+
};
|
|
319
|
+
/** @description The requestor attempted to deploy a malformed Flow.
|
|
320
|
+
* */
|
|
321
|
+
400: {
|
|
322
|
+
headers: {
|
|
323
|
+
[name: string]: unknown;
|
|
324
|
+
};
|
|
325
|
+
content?: never;
|
|
326
|
+
};
|
|
327
|
+
/** @description The requestor is not authorized to deploy a Flow.
|
|
328
|
+
* */
|
|
329
|
+
403: {
|
|
330
|
+
headers: {
|
|
331
|
+
[name: string]: unknown;
|
|
332
|
+
};
|
|
333
|
+
content?: never;
|
|
334
|
+
};
|
|
335
|
+
};
|
|
336
|
+
};
|
|
337
|
+
delete?: never;
|
|
338
|
+
options?: never;
|
|
339
|
+
head?: never;
|
|
340
|
+
patch?: never;
|
|
341
|
+
trace?: never;
|
|
342
|
+
};
|
|
343
|
+
"/flows/validate": {
|
|
344
|
+
parameters: {
|
|
345
|
+
query?: never;
|
|
346
|
+
header?: never;
|
|
347
|
+
path?: never;
|
|
348
|
+
cookie?: never;
|
|
349
|
+
};
|
|
350
|
+
get?: never;
|
|
351
|
+
put?: never;
|
|
352
|
+
/**
|
|
353
|
+
* Validate a flow
|
|
354
|
+
* @description Validate a flow definition and its schema.
|
|
355
|
+
*/
|
|
356
|
+
post: {
|
|
357
|
+
parameters: {
|
|
358
|
+
query?: never;
|
|
359
|
+
header?: never;
|
|
360
|
+
path?: never;
|
|
361
|
+
cookie?: never;
|
|
362
|
+
};
|
|
363
|
+
requestBody: {
|
|
364
|
+
content: {
|
|
365
|
+
"application/json": {
|
|
366
|
+
definition: components["schemas"]["FlowDefinition"];
|
|
367
|
+
/** @description A JSON Schema describing valid input to the flow.
|
|
368
|
+
* */
|
|
369
|
+
input_schema?: Record<string, unknown>;
|
|
370
|
+
};
|
|
371
|
+
};
|
|
372
|
+
};
|
|
373
|
+
responses: {
|
|
374
|
+
/** @description The flow passed all validation checks.
|
|
375
|
+
* */
|
|
376
|
+
200: {
|
|
377
|
+
headers: {
|
|
378
|
+
[name: string]: unknown;
|
|
379
|
+
};
|
|
380
|
+
content: {
|
|
381
|
+
"application/json": components["schemas"]["FlowValidationResponse"];
|
|
382
|
+
};
|
|
383
|
+
};
|
|
384
|
+
/** @description The requestor attempted to validate a malformed flow.
|
|
385
|
+
* */
|
|
386
|
+
400: {
|
|
387
|
+
headers: {
|
|
388
|
+
[name: string]: unknown;
|
|
389
|
+
};
|
|
390
|
+
content?: never;
|
|
391
|
+
};
|
|
392
|
+
/** @description The requestor is not authorized to validate a flow.
|
|
393
|
+
* */
|
|
394
|
+
403: {
|
|
395
|
+
headers: {
|
|
396
|
+
[name: string]: unknown;
|
|
397
|
+
};
|
|
398
|
+
content?: never;
|
|
399
|
+
};
|
|
400
|
+
/** @description A conflict was found in the flow definition or input schema.
|
|
401
|
+
* */
|
|
402
|
+
409: {
|
|
403
|
+
headers: {
|
|
404
|
+
[name: string]: unknown;
|
|
405
|
+
};
|
|
406
|
+
content?: never;
|
|
407
|
+
};
|
|
408
|
+
/** @description The flow definition or input schema failed validation checks.
|
|
409
|
+
* */
|
|
410
|
+
422: {
|
|
411
|
+
headers: {
|
|
412
|
+
[name: string]: unknown;
|
|
413
|
+
};
|
|
414
|
+
content: {
|
|
415
|
+
"application/json": components["schemas"]["FlowValidationErrorResponse"];
|
|
416
|
+
};
|
|
417
|
+
};
|
|
418
|
+
};
|
|
419
|
+
};
|
|
420
|
+
delete?: never;
|
|
421
|
+
options?: never;
|
|
422
|
+
head?: never;
|
|
423
|
+
patch?: never;
|
|
424
|
+
trace?: never;
|
|
425
|
+
};
|
|
426
|
+
"/flows/{flow_id}": {
|
|
427
|
+
parameters: {
|
|
428
|
+
query?: never;
|
|
429
|
+
header?: never;
|
|
430
|
+
path: {
|
|
431
|
+
/** @description The flow ID */
|
|
432
|
+
flow_id: components["parameters"]["flow_id"];
|
|
433
|
+
};
|
|
434
|
+
cookie?: never;
|
|
435
|
+
};
|
|
436
|
+
/**
|
|
437
|
+
* Retrieve a Flow
|
|
438
|
+
* @description Get a previously deployed Flow.
|
|
439
|
+
*/
|
|
440
|
+
get: {
|
|
441
|
+
parameters: {
|
|
442
|
+
query?: never;
|
|
443
|
+
header?: never;
|
|
444
|
+
path: {
|
|
445
|
+
/** @description The flow ID */
|
|
446
|
+
flow_id: components["parameters"]["flow_id"];
|
|
447
|
+
};
|
|
448
|
+
cookie?: never;
|
|
449
|
+
};
|
|
450
|
+
requestBody?: never;
|
|
451
|
+
responses: {
|
|
452
|
+
/** @description The requestor has successfully authenticated and queried the Flow's
|
|
453
|
+
* service for a specific Flow definition.
|
|
454
|
+
* */
|
|
455
|
+
200: {
|
|
456
|
+
headers: {
|
|
457
|
+
[name: string]: unknown;
|
|
458
|
+
};
|
|
459
|
+
content: {
|
|
460
|
+
"application/json": components["schemas"]["FlowResponse"];
|
|
461
|
+
};
|
|
462
|
+
};
|
|
463
|
+
/** @description The requestor attempted to retrieve a Flow definition for which they
|
|
464
|
+
* did not have access.
|
|
465
|
+
* */
|
|
466
|
+
403: {
|
|
467
|
+
headers: {
|
|
468
|
+
[name: string]: unknown;
|
|
469
|
+
};
|
|
470
|
+
content?: never;
|
|
471
|
+
};
|
|
472
|
+
/** @description The requestor attempted to retrieve a non-existent Flow, or the
|
|
473
|
+
* requestor did not have permissions to view a Flow.
|
|
474
|
+
* */
|
|
475
|
+
404: {
|
|
476
|
+
headers: {
|
|
477
|
+
[name: string]: unknown;
|
|
478
|
+
};
|
|
479
|
+
content?: never;
|
|
480
|
+
};
|
|
481
|
+
};
|
|
482
|
+
};
|
|
483
|
+
/**
|
|
484
|
+
* Update a Flow
|
|
485
|
+
* @description Update a previously deployed Flow.
|
|
486
|
+
*/
|
|
487
|
+
put: {
|
|
488
|
+
parameters: {
|
|
489
|
+
query?: never;
|
|
490
|
+
header?: never;
|
|
491
|
+
path: {
|
|
492
|
+
/** @description The flow ID */
|
|
493
|
+
flow_id: components["parameters"]["flow_id"];
|
|
494
|
+
};
|
|
495
|
+
cookie?: never;
|
|
496
|
+
};
|
|
497
|
+
requestBody: {
|
|
498
|
+
content: {
|
|
499
|
+
"application/json": {
|
|
500
|
+
definition?: components["schemas"]["FlowDefinition"];
|
|
501
|
+
/** @description A JSON schema document.
|
|
502
|
+
*
|
|
503
|
+
* When starting the flow, input keys and values must conform to the schema.
|
|
504
|
+
* The Globus Web App uses the input schema to created a guided input page when starting the flow.
|
|
505
|
+
* */
|
|
506
|
+
input_schema?: Record<string, unknown>;
|
|
507
|
+
/** @description A non-unique, human-friendly name used for displaying the flow to end users.
|
|
508
|
+
* */
|
|
509
|
+
title?: string;
|
|
510
|
+
/** @description A short summary of the flow's purpose or functionality.
|
|
511
|
+
* */
|
|
512
|
+
subtitle?: string;
|
|
513
|
+
/** @description Arbitrary text to describe the Flow.
|
|
514
|
+
* */
|
|
515
|
+
description?: string;
|
|
516
|
+
/** @description If provided, the value must be the calling user's Globus Auth identity URN,
|
|
517
|
+
* and the user must be a flow administrator.
|
|
518
|
+
*
|
|
519
|
+
* It is not possible for non-administrators to take ownership of a flow.
|
|
520
|
+
* Also, it is currently not possible to assign ownership to another user.
|
|
521
|
+
* */
|
|
522
|
+
flow_owner?: string;
|
|
523
|
+
/** @description A list of Globus Auth identity and group URNs that may administer the flow.
|
|
524
|
+
*
|
|
525
|
+
* Flow administrators are able to see the full flow definition,
|
|
526
|
+
* including any parameters listed in a "__Private_Parameters" value.
|
|
527
|
+
* */
|
|
528
|
+
flow_administrators?: string[];
|
|
529
|
+
/** @description A list of Globus Auth identity and group URNs that may start the flow.
|
|
530
|
+
*
|
|
531
|
+
* It is possible to make a flow available for use to all authenticated users
|
|
532
|
+
* -- including those outside your organization or domain --
|
|
533
|
+
* by using the special value "all_authenticated_users".
|
|
534
|
+
*
|
|
535
|
+
* Parameters listed in "__Private_Parameters" values in the definition
|
|
536
|
+
* will be removed from the definition when it is viewed by a flow starter.
|
|
537
|
+
* */
|
|
538
|
+
flow_starters?: string[];
|
|
539
|
+
/** @description A list of Globus Auth identity and group URNs that may see the flow,
|
|
540
|
+
* including its definition and input schema.
|
|
541
|
+
*
|
|
542
|
+
* It is possible to make a flow available for viewing to all users
|
|
543
|
+
* -- including those outside your organization or domain --
|
|
544
|
+
* by using the special value "public".
|
|
545
|
+
*
|
|
546
|
+
* Parameters listed in "__Private_Parameters" values in the definition
|
|
547
|
+
* will be removed from the definition when it is viewed by a flow starter.
|
|
548
|
+
* */
|
|
549
|
+
flow_viewers?: string[];
|
|
550
|
+
/** @description A list of keywords that can be used for grouping or identifying flows.
|
|
551
|
+
* */
|
|
552
|
+
keywords?: string[];
|
|
553
|
+
run_managers?: components["schemas"]["RunManagers"];
|
|
554
|
+
run_monitors?: components["schemas"]["RunMonitors"];
|
|
555
|
+
subscription_id?: string & (unknown | "DEFAULT");
|
|
556
|
+
};
|
|
557
|
+
};
|
|
558
|
+
};
|
|
559
|
+
responses: {
|
|
560
|
+
/** @description The requestor has successfully authenticated and updated the target
|
|
561
|
+
* Flow definition.
|
|
562
|
+
* */
|
|
563
|
+
200: {
|
|
564
|
+
headers: {
|
|
565
|
+
[name: string]: unknown;
|
|
566
|
+
};
|
|
567
|
+
content: {
|
|
568
|
+
"application/json": components["schemas"]["FlowResponse"];
|
|
569
|
+
};
|
|
570
|
+
};
|
|
571
|
+
/** @description The Flow definition update failed due to an attempt to perform a
|
|
572
|
+
* malformed update.
|
|
573
|
+
* */
|
|
574
|
+
400: {
|
|
575
|
+
headers: {
|
|
576
|
+
[name: string]: unknown;
|
|
577
|
+
};
|
|
578
|
+
content?: never;
|
|
579
|
+
};
|
|
580
|
+
/** @description The requestor attempted to update a Flow for which they did not have
|
|
581
|
+
* access.
|
|
582
|
+
* */
|
|
583
|
+
403: {
|
|
584
|
+
headers: {
|
|
585
|
+
[name: string]: unknown;
|
|
586
|
+
};
|
|
587
|
+
content?: never;
|
|
588
|
+
};
|
|
589
|
+
/** @description The requestor attempted to update a non-existent Flow, or the
|
|
590
|
+
* requestor did not have permissions to update a Flow.
|
|
591
|
+
* */
|
|
592
|
+
404: {
|
|
593
|
+
headers: {
|
|
594
|
+
[name: string]: unknown;
|
|
595
|
+
};
|
|
596
|
+
content?: never;
|
|
597
|
+
};
|
|
598
|
+
};
|
|
599
|
+
};
|
|
600
|
+
post?: never;
|
|
601
|
+
/**
|
|
602
|
+
* Remove a Flow
|
|
603
|
+
* @description Remove a Flow from the Flow service.
|
|
604
|
+
*/
|
|
605
|
+
delete: {
|
|
606
|
+
parameters: {
|
|
607
|
+
query?: never;
|
|
608
|
+
header?: never;
|
|
609
|
+
path: {
|
|
610
|
+
/** @description The flow ID */
|
|
611
|
+
flow_id: components["parameters"]["flow_id"];
|
|
612
|
+
};
|
|
613
|
+
cookie?: never;
|
|
614
|
+
};
|
|
615
|
+
requestBody?: never;
|
|
616
|
+
responses: {
|
|
617
|
+
/** @description The requestor has successfully removed the Flow from the Flows
|
|
618
|
+
* service.
|
|
619
|
+
* */
|
|
620
|
+
200: {
|
|
621
|
+
headers: {
|
|
622
|
+
[name: string]: unknown;
|
|
623
|
+
};
|
|
624
|
+
content: {
|
|
625
|
+
"application/json": components["schemas"]["FlowResponse"];
|
|
626
|
+
};
|
|
627
|
+
};
|
|
628
|
+
/** @description The requestor attempted to modify a Flow for which they did not have
|
|
629
|
+
* access.
|
|
630
|
+
* */
|
|
631
|
+
403: {
|
|
632
|
+
headers: {
|
|
633
|
+
[name: string]: unknown;
|
|
634
|
+
};
|
|
635
|
+
content?: never;
|
|
636
|
+
};
|
|
637
|
+
/** @description The requestor attempted to remove a non-existent Flow, or the
|
|
638
|
+
* requestor did not have permissions to remove the Flow.
|
|
639
|
+
* */
|
|
640
|
+
404: {
|
|
641
|
+
headers: {
|
|
642
|
+
[name: string]: unknown;
|
|
643
|
+
};
|
|
644
|
+
content?: never;
|
|
645
|
+
};
|
|
646
|
+
};
|
|
647
|
+
};
|
|
648
|
+
options?: never;
|
|
649
|
+
head?: never;
|
|
650
|
+
patch?: never;
|
|
651
|
+
trace?: never;
|
|
652
|
+
};
|
|
653
|
+
"/flows/{flow_id}/run": {
|
|
654
|
+
parameters: {
|
|
655
|
+
query?: never;
|
|
656
|
+
header?: never;
|
|
657
|
+
path: {
|
|
658
|
+
/** @description The flow ID */
|
|
659
|
+
flow_id: components["parameters"]["flow_id"];
|
|
660
|
+
};
|
|
661
|
+
cookie?: never;
|
|
662
|
+
};
|
|
663
|
+
get?: never;
|
|
664
|
+
put?: never;
|
|
665
|
+
/**
|
|
666
|
+
* Start a Flow
|
|
667
|
+
* @description Start a particular Flow, which creates a Run.
|
|
668
|
+
*/
|
|
669
|
+
post: {
|
|
670
|
+
parameters: {
|
|
671
|
+
query?: never;
|
|
672
|
+
header?: never;
|
|
673
|
+
path: {
|
|
674
|
+
/** @description The flow ID */
|
|
675
|
+
flow_id: components["parameters"]["flow_id"];
|
|
676
|
+
};
|
|
677
|
+
cookie?: never;
|
|
678
|
+
};
|
|
679
|
+
requestBody: {
|
|
680
|
+
content: {
|
|
681
|
+
"application/json": {
|
|
682
|
+
body: components["schemas"]["InputBody"];
|
|
683
|
+
run_monitors?: components["schemas"]["RunMonitors"];
|
|
684
|
+
run_managers?: components["schemas"]["RunManagers"];
|
|
685
|
+
label?: components["schemas"]["Label"];
|
|
686
|
+
tags?: components["schemas"]["Tags"];
|
|
687
|
+
activity_notification_policy?: components["schemas"]["ActivityNotificationPolicy"];
|
|
688
|
+
};
|
|
689
|
+
};
|
|
690
|
+
};
|
|
691
|
+
responses: {
|
|
692
|
+
/** @description The Run was successfully started. */
|
|
693
|
+
201: {
|
|
694
|
+
headers: {
|
|
695
|
+
[name: string]: unknown;
|
|
696
|
+
};
|
|
697
|
+
content: {
|
|
698
|
+
"application/json": components["schemas"]["FlowRun"];
|
|
699
|
+
};
|
|
700
|
+
};
|
|
701
|
+
/** @description The Run's input failed validation against the Flow's input schema.
|
|
702
|
+
* */
|
|
703
|
+
400: {
|
|
704
|
+
headers: {
|
|
705
|
+
[name: string]: unknown;
|
|
706
|
+
};
|
|
707
|
+
content?: never;
|
|
708
|
+
};
|
|
709
|
+
/** @description The requestor presented a token with insufficient scopes.
|
|
710
|
+
* */
|
|
711
|
+
403: {
|
|
712
|
+
headers: {
|
|
713
|
+
[name: string]: unknown;
|
|
714
|
+
};
|
|
715
|
+
content?: never;
|
|
716
|
+
};
|
|
717
|
+
/** @description The requestor did not have access to run the provided Flow, or the
|
|
718
|
+
* Flow does not exist.
|
|
719
|
+
* */
|
|
720
|
+
404: {
|
|
721
|
+
headers: {
|
|
722
|
+
[name: string]: unknown;
|
|
723
|
+
};
|
|
724
|
+
content?: never;
|
|
725
|
+
};
|
|
726
|
+
/** @description The input tags did not pass validation. */
|
|
727
|
+
422: {
|
|
728
|
+
headers: {
|
|
729
|
+
[name: string]: unknown;
|
|
730
|
+
};
|
|
731
|
+
content?: never;
|
|
732
|
+
};
|
|
733
|
+
/** @description An upstream service has imposed rate limiting.
|
|
734
|
+
* The requestor may resubmit the API request.
|
|
735
|
+
* */
|
|
736
|
+
429: {
|
|
737
|
+
headers: {
|
|
738
|
+
[name: string]: unknown;
|
|
739
|
+
};
|
|
740
|
+
content?: never;
|
|
741
|
+
};
|
|
742
|
+
/** @description An upstream service returned an uncorrectable error.
|
|
743
|
+
* The error may or may not occur if the API request is submitted again.
|
|
744
|
+
* It may be possible to resubmit the API request.
|
|
745
|
+
* */
|
|
746
|
+
502: {
|
|
747
|
+
headers: {
|
|
748
|
+
[name: string]: unknown;
|
|
749
|
+
};
|
|
750
|
+
content?: never;
|
|
751
|
+
};
|
|
752
|
+
};
|
|
753
|
+
};
|
|
754
|
+
delete?: never;
|
|
755
|
+
options?: never;
|
|
756
|
+
head?: never;
|
|
757
|
+
patch?: never;
|
|
758
|
+
trace?: never;
|
|
759
|
+
};
|
|
760
|
+
"/flows/{flow_id}/validate_run": {
|
|
761
|
+
parameters: {
|
|
762
|
+
query?: never;
|
|
763
|
+
header?: never;
|
|
764
|
+
path: {
|
|
765
|
+
/** @description The flow ID */
|
|
766
|
+
flow_id: components["parameters"]["flow_id"];
|
|
767
|
+
};
|
|
768
|
+
cookie?: never;
|
|
769
|
+
};
|
|
770
|
+
get?: never;
|
|
771
|
+
put?: never;
|
|
772
|
+
/**
|
|
773
|
+
* Validate a run
|
|
774
|
+
* @description Validate that a run input body will pass the target flow's input schema validation (if any),
|
|
775
|
+
* that run metadata will meet the Flows service's metadata constraints,
|
|
776
|
+
* and that known scope requirements are met by the user's or client's Globus Auth token.
|
|
777
|
+
*
|
|
778
|
+
* If validation passes, then it is likely that the flow can be started
|
|
779
|
+
* with the same inputs and Globus Auth token.
|
|
780
|
+
*
|
|
781
|
+
*/
|
|
782
|
+
post: {
|
|
783
|
+
parameters: {
|
|
784
|
+
query?: never;
|
|
785
|
+
header?: never;
|
|
786
|
+
path: {
|
|
787
|
+
/** @description The flow ID */
|
|
788
|
+
flow_id: components["parameters"]["flow_id"];
|
|
789
|
+
};
|
|
790
|
+
cookie?: never;
|
|
791
|
+
};
|
|
792
|
+
requestBody: {
|
|
793
|
+
content: {
|
|
794
|
+
"application/json": {
|
|
795
|
+
activity_notification_policy?: components["schemas"]["ActivityNotificationPolicy"];
|
|
796
|
+
body: components["schemas"]["InputBody"];
|
|
797
|
+
label?: components["schemas"]["Label"];
|
|
798
|
+
run_managers?: components["schemas"]["RunManagers"];
|
|
799
|
+
run_monitors?: components["schemas"]["RunMonitors"];
|
|
800
|
+
tags?: components["schemas"]["Tags"];
|
|
801
|
+
};
|
|
802
|
+
};
|
|
803
|
+
};
|
|
804
|
+
responses: {
|
|
805
|
+
/** @description The inputs and Globus Auth token passed validation.
|
|
806
|
+
*
|
|
807
|
+
* It is likely that the user or client will be able to start the flow
|
|
808
|
+
* using the same Globus Auth token and input values.
|
|
809
|
+
* */
|
|
810
|
+
200: {
|
|
811
|
+
headers: {
|
|
812
|
+
[name: string]: unknown;
|
|
813
|
+
};
|
|
814
|
+
content: {
|
|
815
|
+
"application/json": components["schemas"]["ValidateRun"];
|
|
816
|
+
};
|
|
817
|
+
};
|
|
818
|
+
/** @description The input body failed validation against the flow's input schema.
|
|
819
|
+
* */
|
|
820
|
+
400: {
|
|
821
|
+
headers: {
|
|
822
|
+
[name: string]: unknown;
|
|
823
|
+
};
|
|
824
|
+
content?: never;
|
|
825
|
+
};
|
|
826
|
+
/** @description The user or client is not allowed to run the flow,
|
|
827
|
+
* or the Globus Auth token is missing required scopes.
|
|
828
|
+
* */
|
|
829
|
+
403: {
|
|
830
|
+
headers: {
|
|
831
|
+
[name: string]: unknown;
|
|
832
|
+
};
|
|
833
|
+
content?: never;
|
|
834
|
+
};
|
|
835
|
+
};
|
|
836
|
+
};
|
|
837
|
+
delete?: never;
|
|
838
|
+
options?: never;
|
|
839
|
+
head?: never;
|
|
840
|
+
patch?: never;
|
|
841
|
+
trace?: never;
|
|
842
|
+
};
|
|
843
|
+
"/runs/{run_id}/release": {
|
|
844
|
+
parameters: {
|
|
845
|
+
query?: never;
|
|
846
|
+
header?: never;
|
|
847
|
+
path: {
|
|
848
|
+
/** @description The run ID */
|
|
849
|
+
run_id: components["parameters"]["run_id"];
|
|
850
|
+
};
|
|
851
|
+
cookie?: never;
|
|
852
|
+
};
|
|
853
|
+
get?: never;
|
|
854
|
+
put?: never;
|
|
855
|
+
/**
|
|
856
|
+
* Remove a Run
|
|
857
|
+
* @description Remove the state for a particular invocation of a Flow.
|
|
858
|
+
*/
|
|
859
|
+
post: {
|
|
860
|
+
parameters: {
|
|
861
|
+
query?: never;
|
|
862
|
+
header?: never;
|
|
863
|
+
path: {
|
|
864
|
+
/** @description The run ID */
|
|
865
|
+
run_id: components["parameters"]["run_id"];
|
|
866
|
+
};
|
|
867
|
+
cookie?: never;
|
|
868
|
+
};
|
|
869
|
+
requestBody?: never;
|
|
870
|
+
responses: {
|
|
871
|
+
/** @description The request was successful. */
|
|
872
|
+
200: {
|
|
873
|
+
headers: {
|
|
874
|
+
[name: string]: unknown;
|
|
875
|
+
};
|
|
876
|
+
content: {
|
|
877
|
+
"application/json": components["schemas"]["FlowRun"];
|
|
878
|
+
};
|
|
879
|
+
};
|
|
880
|
+
/** @description The requestor is not authorized to access the run or flow,
|
|
881
|
+
* or has not provided access tokens with sufficient privileges.
|
|
882
|
+
* */
|
|
883
|
+
403: {
|
|
884
|
+
headers: {
|
|
885
|
+
[name: string]: unknown;
|
|
886
|
+
};
|
|
887
|
+
content?: never;
|
|
888
|
+
};
|
|
889
|
+
/** @description The requested Run or Flow was not found. Or, the requestor did not
|
|
890
|
+
* have access to view the Run.
|
|
891
|
+
* */
|
|
892
|
+
404: {
|
|
893
|
+
headers: {
|
|
894
|
+
[name: string]: unknown;
|
|
895
|
+
};
|
|
896
|
+
content?: never;
|
|
897
|
+
};
|
|
898
|
+
/** @description The requestor attempted to remove the state for a Run which had
|
|
899
|
+
* not yet reached a completed status.
|
|
900
|
+
* */
|
|
901
|
+
409: {
|
|
902
|
+
headers: {
|
|
903
|
+
[name: string]: unknown;
|
|
904
|
+
};
|
|
905
|
+
content?: never;
|
|
906
|
+
};
|
|
907
|
+
/** @description An upstream service rate-limited the request to release the Run.
|
|
908
|
+
* The requestor may re-submit the request at a later time.
|
|
909
|
+
* */
|
|
910
|
+
429: {
|
|
911
|
+
headers: {
|
|
912
|
+
[name: string]: unknown;
|
|
913
|
+
};
|
|
914
|
+
content?: never;
|
|
915
|
+
};
|
|
916
|
+
/** @description The run is in an unexpected state in the Flows service.
|
|
917
|
+
* Please contact Globus support.
|
|
918
|
+
* */
|
|
919
|
+
500: {
|
|
920
|
+
headers: {
|
|
921
|
+
[name: string]: unknown;
|
|
922
|
+
};
|
|
923
|
+
content?: never;
|
|
924
|
+
};
|
|
925
|
+
/** @description A request to an upstream service failed for an unknown reason.
|
|
926
|
+
* The requestor can re-submit the request or contact Globus support.
|
|
927
|
+
* */
|
|
928
|
+
502: {
|
|
929
|
+
headers: {
|
|
930
|
+
[name: string]: unknown;
|
|
931
|
+
};
|
|
932
|
+
content?: never;
|
|
933
|
+
};
|
|
934
|
+
};
|
|
935
|
+
};
|
|
936
|
+
delete?: never;
|
|
937
|
+
options?: never;
|
|
938
|
+
head?: never;
|
|
939
|
+
patch?: never;
|
|
940
|
+
trace?: never;
|
|
941
|
+
};
|
|
942
|
+
"/flows/{flow_id}/{run_id}/resume": {
|
|
943
|
+
parameters: {
|
|
944
|
+
query?: never;
|
|
945
|
+
header?: never;
|
|
946
|
+
path: {
|
|
947
|
+
/** @description The flow ID */
|
|
948
|
+
flow_id: components["parameters"]["flow_id"];
|
|
949
|
+
/** @description The run ID */
|
|
950
|
+
run_id: components["parameters"]["run_id"];
|
|
951
|
+
};
|
|
952
|
+
cookie?: never;
|
|
953
|
+
};
|
|
954
|
+
get?: never;
|
|
955
|
+
put?: never;
|
|
956
|
+
/**
|
|
957
|
+
* Resume a Run
|
|
958
|
+
* @description Attempt to resume a Run, particularly when it has reached a
|
|
959
|
+
* status of INACTIVE. A Flow Run may reach an INACTIVE status
|
|
960
|
+
* when an Action type state within the Flow returns its status
|
|
961
|
+
* as INACTIVE. The resume operation on the Flow Run provides a
|
|
962
|
+
* hint that the cause of the Action becoming INACTIVE may have
|
|
963
|
+
* been cleared, and thus the resume operation on the Action
|
|
964
|
+
* Provider should be invoked to allow the Action state to resume
|
|
965
|
+
* and thus resume the Flow Run.
|
|
966
|
+
*
|
|
967
|
+
* In the particular case that an Action state is INACTIVE with a
|
|
968
|
+
* code value of "ConsentRequired" it is further assumed that the
|
|
969
|
+
* Bearer token provided in the Authorization header on the
|
|
970
|
+
* resume operation now carries sufficient consents to continue
|
|
971
|
+
* the INACTIVE Action. Thus, the Flow service will use the
|
|
972
|
+
* Bearer token to generate new dependent tokens for running the
|
|
973
|
+
* Action and use these tokens to request that the Action be
|
|
974
|
+
* resumed at the Action Provider.
|
|
975
|
+
*
|
|
976
|
+
* Note again that in reasons other than "ConsentRequired" for a
|
|
977
|
+
* Flow or Action to go INACTIVE, the resume operation is just a
|
|
978
|
+
* hint. For example, when the code is "ActivationRequired,"
|
|
979
|
+
* indicating that a Globus collection or endpoint needs to be
|
|
980
|
+
* Activated by the user, performing that Activation out-of-band
|
|
981
|
+
* from the Flow will allow the Flow to proceed even without the
|
|
982
|
+
* resume operation as the Action is periodically polled for
|
|
983
|
+
* progress. Performing the resume operation may simply cause a
|
|
984
|
+
* poll to happen more quickly and thus allow the Action to
|
|
985
|
+
* resume more quickly.
|
|
986
|
+
*
|
|
987
|
+
*/
|
|
988
|
+
post: {
|
|
989
|
+
parameters: {
|
|
990
|
+
query?: never;
|
|
991
|
+
header?: never;
|
|
992
|
+
path: {
|
|
993
|
+
/** @description The flow ID */
|
|
994
|
+
flow_id: components["parameters"]["flow_id"];
|
|
995
|
+
/** @description The run ID */
|
|
996
|
+
run_id: components["parameters"]["run_id"];
|
|
997
|
+
};
|
|
998
|
+
cookie?: never;
|
|
999
|
+
};
|
|
1000
|
+
requestBody?: never;
|
|
1001
|
+
responses: {
|
|
1002
|
+
/** @description The request was successful. */
|
|
1003
|
+
200: {
|
|
1004
|
+
headers: {
|
|
1005
|
+
[name: string]: unknown;
|
|
1006
|
+
};
|
|
1007
|
+
content: {
|
|
1008
|
+
"application/json": components["schemas"]["FlowRun"];
|
|
1009
|
+
};
|
|
1010
|
+
};
|
|
1011
|
+
/** @description The requested Run or Flow was not found. Or, the requestor did not
|
|
1012
|
+
* have access to manage the Run.
|
|
1013
|
+
* */
|
|
1014
|
+
404: {
|
|
1015
|
+
headers: {
|
|
1016
|
+
[name: string]: unknown;
|
|
1017
|
+
};
|
|
1018
|
+
content?: never;
|
|
1019
|
+
};
|
|
1020
|
+
};
|
|
1021
|
+
};
|
|
1022
|
+
delete?: never;
|
|
1023
|
+
options?: never;
|
|
1024
|
+
head?: never;
|
|
1025
|
+
patch?: never;
|
|
1026
|
+
trace?: never;
|
|
1027
|
+
};
|
|
1028
|
+
"/runs/{run_id}/resume": paths["/flows/{flow_id}/{run_id}/resume"];
|
|
1029
|
+
"/runs/{run_id}/cancel": {
|
|
1030
|
+
parameters: {
|
|
1031
|
+
query?: never;
|
|
1032
|
+
header?: never;
|
|
1033
|
+
path: {
|
|
1034
|
+
/** @description The run ID */
|
|
1035
|
+
run_id: components["parameters"]["run_id"];
|
|
1036
|
+
};
|
|
1037
|
+
cookie?: never;
|
|
1038
|
+
};
|
|
1039
|
+
get?: never;
|
|
1040
|
+
put?: never;
|
|
1041
|
+
/**
|
|
1042
|
+
* Cancel a Run
|
|
1043
|
+
* @description Cancel the execution for a particular Run of a Flow.
|
|
1044
|
+
*/
|
|
1045
|
+
post: {
|
|
1046
|
+
parameters: {
|
|
1047
|
+
query?: never;
|
|
1048
|
+
header?: never;
|
|
1049
|
+
path: {
|
|
1050
|
+
/** @description The run ID */
|
|
1051
|
+
run_id: components["parameters"]["run_id"];
|
|
1052
|
+
};
|
|
1053
|
+
cookie?: never;
|
|
1054
|
+
};
|
|
1055
|
+
requestBody?: never;
|
|
1056
|
+
responses: {
|
|
1057
|
+
/** @description The request was successfully received. */
|
|
1058
|
+
202: {
|
|
1059
|
+
headers: {
|
|
1060
|
+
[name: string]: unknown;
|
|
1061
|
+
};
|
|
1062
|
+
content: {
|
|
1063
|
+
"application/json": components["schemas"]["FlowRun"];
|
|
1064
|
+
};
|
|
1065
|
+
};
|
|
1066
|
+
/** @description The requested Run or Flow was not found. Or, the requestor did not
|
|
1067
|
+
* have access to view the Run.
|
|
1068
|
+
* */
|
|
1069
|
+
404: {
|
|
1070
|
+
headers: {
|
|
1071
|
+
[name: string]: unknown;
|
|
1072
|
+
};
|
|
1073
|
+
content?: never;
|
|
1074
|
+
};
|
|
1075
|
+
/** @description The service encountered an Upstream error when attempting to cancel
|
|
1076
|
+
* the Run.
|
|
1077
|
+
* */
|
|
1078
|
+
502: {
|
|
1079
|
+
headers: {
|
|
1080
|
+
[name: string]: unknown;
|
|
1081
|
+
};
|
|
1082
|
+
content?: never;
|
|
1083
|
+
};
|
|
1084
|
+
};
|
|
1085
|
+
};
|
|
1086
|
+
delete?: never;
|
|
1087
|
+
options?: never;
|
|
1088
|
+
head?: never;
|
|
1089
|
+
patch?: never;
|
|
1090
|
+
trace?: never;
|
|
1091
|
+
};
|
|
1092
|
+
"/flows/{flow_id}/runs/{run_id}/log": {
|
|
1093
|
+
parameters: {
|
|
1094
|
+
query?: {
|
|
1095
|
+
/** @description An integer limit on the number of log records returned. */
|
|
1096
|
+
limit?: number;
|
|
1097
|
+
/** @description A flag to indicate if log records should be returned in reverse order.
|
|
1098
|
+
* */
|
|
1099
|
+
reverse_order?: boolean;
|
|
1100
|
+
/** @description A token used to iterate through pages of returned log records.
|
|
1101
|
+
* */
|
|
1102
|
+
pagination_token?: string;
|
|
1103
|
+
};
|
|
1104
|
+
header?: never;
|
|
1105
|
+
path: {
|
|
1106
|
+
/** @description The flow ID */
|
|
1107
|
+
flow_id: components["parameters"]["flow_id"];
|
|
1108
|
+
/** @description The run ID */
|
|
1109
|
+
run_id: components["parameters"]["run_id"];
|
|
1110
|
+
};
|
|
1111
|
+
cookie?: never;
|
|
1112
|
+
};
|
|
1113
|
+
/**
|
|
1114
|
+
* Get execution details on a Run
|
|
1115
|
+
* @description Retrieve detailed execution information for a particular Flow Run
|
|
1116
|
+
*
|
|
1117
|
+
*/
|
|
1118
|
+
get: {
|
|
1119
|
+
parameters: {
|
|
1120
|
+
query?: {
|
|
1121
|
+
/** @description An integer limit on the number of log records returned. */
|
|
1122
|
+
limit?: number;
|
|
1123
|
+
/** @description A flag to indicate if log records should be returned in reverse order.
|
|
1124
|
+
* */
|
|
1125
|
+
reverse_order?: boolean;
|
|
1126
|
+
/** @description A token used to iterate through pages of returned log records.
|
|
1127
|
+
* */
|
|
1128
|
+
pagination_token?: string;
|
|
1129
|
+
};
|
|
1130
|
+
header?: never;
|
|
1131
|
+
path: {
|
|
1132
|
+
/** @description The flow ID */
|
|
1133
|
+
flow_id: components["parameters"]["flow_id"];
|
|
1134
|
+
/** @description The run ID */
|
|
1135
|
+
run_id: components["parameters"]["run_id"];
|
|
1136
|
+
};
|
|
1137
|
+
cookie?: never;
|
|
1138
|
+
};
|
|
1139
|
+
requestBody?: never;
|
|
1140
|
+
responses: {
|
|
1141
|
+
/** @description The request was successfully received. */
|
|
1142
|
+
200: {
|
|
1143
|
+
headers: {
|
|
1144
|
+
[name: string]: unknown;
|
|
1145
|
+
};
|
|
1146
|
+
content: {
|
|
1147
|
+
"application/json": {
|
|
1148
|
+
/** @description The number of log states returned. */
|
|
1149
|
+
limit: number;
|
|
1150
|
+
/** @description An opaque pagination token for iterating through returned
|
|
1151
|
+
* records. If there are no more entries, this field will not
|
|
1152
|
+
* exist.
|
|
1153
|
+
* */
|
|
1154
|
+
marker?: string;
|
|
1155
|
+
has_next_page: boolean;
|
|
1156
|
+
entries: Record<string, unknown>[];
|
|
1157
|
+
};
|
|
1158
|
+
};
|
|
1159
|
+
};
|
|
1160
|
+
/** @description There was an issue parsing the query parameters.
|
|
1161
|
+
* */
|
|
1162
|
+
400: {
|
|
1163
|
+
headers: {
|
|
1164
|
+
[name: string]: unknown;
|
|
1165
|
+
};
|
|
1166
|
+
content?: never;
|
|
1167
|
+
};
|
|
1168
|
+
/** @description The requested Action or Flow was not found. Or, the
|
|
1169
|
+
* requestor did not have access to view the Action.
|
|
1170
|
+
* */
|
|
1171
|
+
404: {
|
|
1172
|
+
headers: {
|
|
1173
|
+
[name: string]: unknown;
|
|
1174
|
+
};
|
|
1175
|
+
content?: never;
|
|
1176
|
+
};
|
|
1177
|
+
};
|
|
1178
|
+
};
|
|
1179
|
+
put?: never;
|
|
1180
|
+
post?: never;
|
|
1181
|
+
delete?: never;
|
|
1182
|
+
options?: never;
|
|
1183
|
+
head?: never;
|
|
1184
|
+
patch?: never;
|
|
1185
|
+
trace?: never;
|
|
1186
|
+
};
|
|
1187
|
+
"/runs/{run_id}/log": paths["/flows/{flow_id}/runs/{run_id}/log"];
|
|
1188
|
+
"/flows/{flow_id}/runs": {
|
|
1189
|
+
parameters: {
|
|
1190
|
+
query?: never;
|
|
1191
|
+
header?: never;
|
|
1192
|
+
path: {
|
|
1193
|
+
/** @description The flow ID */
|
|
1194
|
+
flow_id: components["parameters"]["flow_id"];
|
|
1195
|
+
};
|
|
1196
|
+
cookie?: never;
|
|
1197
|
+
};
|
|
1198
|
+
/**
|
|
1199
|
+
* Get a Flow's Runs
|
|
1200
|
+
* @description Retrieve a listing of Runs launched from a particular Flow. If hitting
|
|
1201
|
+
* the *\/actions endpoint, the response will list the Runs under a
|
|
1202
|
+
* "actions" key. If hitting the *\/runs endpoint, the response will list
|
|
1203
|
+
* the Runs under a "runs" key.
|
|
1204
|
+
*
|
|
1205
|
+
*/
|
|
1206
|
+
get: {
|
|
1207
|
+
parameters: {
|
|
1208
|
+
query?: {
|
|
1209
|
+
/** @description An opaque token used to iterate through pages of returned Actions.
|
|
1210
|
+
* If provided, all other query arguments will be ignored.
|
|
1211
|
+
* The marker encodes all state in a given query,
|
|
1212
|
+
* therefore it's unnecessary to provide query arguments
|
|
1213
|
+
* once an initial marker has been received.
|
|
1214
|
+
* */
|
|
1215
|
+
marker?: string;
|
|
1216
|
+
/**
|
|
1217
|
+
* @deprecated
|
|
1218
|
+
* @description ("marker" is now the preferred name for this parameter.)
|
|
1219
|
+
* An opaque token used to iterate through pages of returned Actions. If
|
|
1220
|
+
* provided, all other query arguments will be ignored. The
|
|
1221
|
+
* pagination_token encodes all state in a given query, therefore it's
|
|
1222
|
+
* unnecessary to provide query arguments once an initial token has been
|
|
1223
|
+
* received.
|
|
1224
|
+
*
|
|
1225
|
+
*/
|
|
1226
|
+
pagination_token?: string;
|
|
1227
|
+
/**
|
|
1228
|
+
* @description The number of results to return in a single paged response.
|
|
1229
|
+
*
|
|
1230
|
+
* @example 50
|
|
1231
|
+
*/
|
|
1232
|
+
per_page?: number;
|
|
1233
|
+
/**
|
|
1234
|
+
* @description The page of results to return.
|
|
1235
|
+
* @example 2
|
|
1236
|
+
*/
|
|
1237
|
+
page?: number;
|
|
1238
|
+
/**
|
|
1239
|
+
* @description Return Actions for which the user has the supplied role. The role the
|
|
1240
|
+
* user has on the Action dictates the operations they can perform.
|
|
1241
|
+
* If multiple roles are specified, the user will have at least one of
|
|
1242
|
+
* the specified roles on each Action returned.
|
|
1243
|
+
*
|
|
1244
|
+
* @example [
|
|
1245
|
+
* "run_manager"
|
|
1246
|
+
* ]
|
|
1247
|
+
*/
|
|
1248
|
+
filter_roles?: ("run_owner" | "run_manager" | "run_monitor" | "flow_run_manager" | "flow_run_monitor")[];
|
|
1249
|
+
/**
|
|
1250
|
+
* @deprecated
|
|
1251
|
+
* @description Return Actions for which the user has the provided
|
|
1252
|
+
* role. The role the user has on the Action dictates the
|
|
1253
|
+
* operations they can perform. Roles are cumulative in the
|
|
1254
|
+
* sense that having, for example, the "run_manager" role also
|
|
1255
|
+
* implies having the "run_monitor" role. Thus, specifying
|
|
1256
|
+
* manager will also include all Actions for which the user
|
|
1257
|
+
* has "run_monitor" role as well. If not provided, only Actions
|
|
1258
|
+
* for which the caller has "run_owner" role will be returned.
|
|
1259
|
+
*
|
|
1260
|
+
* @example [
|
|
1261
|
+
* "run_manager"
|
|
1262
|
+
* ]
|
|
1263
|
+
*/
|
|
1264
|
+
filter_role?: "run_monitor" | "run_manager" | "run_owner" | "flow_run_manager" | "flow_run_monitor";
|
|
1265
|
+
/**
|
|
1266
|
+
* @description Return Actions which are in the specified state. The state of the
|
|
1267
|
+
* Action dictates the operations which can performed on them. If
|
|
1268
|
+
* multiple statuses are specified, each Action returned will be in one
|
|
1269
|
+
* of the specified states. By default, Actions in any state will be
|
|
1270
|
+
* returned.
|
|
1271
|
+
*
|
|
1272
|
+
* @example [
|
|
1273
|
+
* "FAILED",
|
|
1274
|
+
* "INACTIVE"
|
|
1275
|
+
* ]
|
|
1276
|
+
*/
|
|
1277
|
+
filter_status?: ("SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE")[];
|
|
1278
|
+
/**
|
|
1279
|
+
* @description Performs a case insensitive string based search on the Actions'
|
|
1280
|
+
* label fields. If multiple values are specified, each Action returned
|
|
1281
|
+
* is guaranteed to contain at least one of the strings in its label.
|
|
1282
|
+
*
|
|
1283
|
+
* @example [
|
|
1284
|
+
* "science",
|
|
1285
|
+
* "tests"
|
|
1286
|
+
* ]
|
|
1287
|
+
*/
|
|
1288
|
+
filter_label?: string[];
|
|
1289
|
+
/**
|
|
1290
|
+
* @description Given a pair of comma-separated ISO 8601 datetime strings,
|
|
1291
|
+
* filter results to only those runs which completed execution
|
|
1292
|
+
* within the specified range.
|
|
1293
|
+
*
|
|
1294
|
+
* If one of the dates is omitted, it forms an open range.
|
|
1295
|
+
* For example, if the filter has a datetime followed by a comma (`"DT,"`),
|
|
1296
|
+
* all records with a date greater then or equal to `DT` will be returned.
|
|
1297
|
+
* Similarly, if the filter has a comma followed by a datetime (`",DT"`),
|
|
1298
|
+
* all records with dates less than `DT` will be returned.
|
|
1299
|
+
* If there is no comma, it is treated in the same way as `"DT,"`, above.
|
|
1300
|
+
*
|
|
1301
|
+
* Results will contain runs which completed between the first datetime
|
|
1302
|
+
* onwards, up to (but not including) the second datetime.
|
|
1303
|
+
*
|
|
1304
|
+
* Note that runs which are still executing will not have a completion time
|
|
1305
|
+
* and will be automatically excluded if this filter is applied.
|
|
1306
|
+
*
|
|
1307
|
+
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
1308
|
+
*/
|
|
1309
|
+
filter_completion_time?: components["parameters"]["filter_completion_time"];
|
|
1310
|
+
/**
|
|
1311
|
+
* @description Given a pair of comma separated ISO 8601 date/time strings,
|
|
1312
|
+
* filter results to only those runs which started execution
|
|
1313
|
+
* within the specified range.
|
|
1314
|
+
*
|
|
1315
|
+
* If one of the dates is omitted, it forms an open range.
|
|
1316
|
+
* For example, if the filter has a datetime followed by a comma (`"DT,"`),
|
|
1317
|
+
* all records with a date greater then or equal to `DT` will be returned.
|
|
1318
|
+
* Similarly, if the filter has a comma followed by a datetime (`",DT"`),
|
|
1319
|
+
* all records with dates less than `DT` will be returned.
|
|
1320
|
+
* If there is no comma, it is treated in the same way as `"DT,"`, above.
|
|
1321
|
+
*
|
|
1322
|
+
* Results will contain runs which began between the first datetime
|
|
1323
|
+
* onwards, up to (but not including) the second datetime.
|
|
1324
|
+
*
|
|
1325
|
+
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
1326
|
+
*/
|
|
1327
|
+
filter_start_time?: components["parameters"]["filter_start_time"];
|
|
1328
|
+
/**
|
|
1329
|
+
* @description Ordering criteria to apply to the list of runs.
|
|
1330
|
+
*
|
|
1331
|
+
* This field is a comma-separated list of sort criteria,
|
|
1332
|
+
* and follows this syntax:
|
|
1333
|
+
*
|
|
1334
|
+
* ```
|
|
1335
|
+
* CRITERION1[,CRITERION2[,...]]
|
|
1336
|
+
* ```
|
|
1337
|
+
*
|
|
1338
|
+
* and each individual `CRITERION` follows this syntax:
|
|
1339
|
+
*
|
|
1340
|
+
* ```
|
|
1341
|
+
* FIELD ORDERING
|
|
1342
|
+
* ```
|
|
1343
|
+
*
|
|
1344
|
+
* The first value, `FIELD`, indicates the field to sort by;
|
|
1345
|
+
* the second value, `ORDERING`, indicates the sorting order.
|
|
1346
|
+
*
|
|
1347
|
+
* When additional comma-separated criteria are added,
|
|
1348
|
+
* the first criterion will be used to sort the data;
|
|
1349
|
+
* subsequent criteria will be applied for ties.
|
|
1350
|
+
*
|
|
1351
|
+
* Supported fields are:
|
|
1352
|
+
*
|
|
1353
|
+
* - `id`
|
|
1354
|
+
* - `start_time`
|
|
1355
|
+
* - `completion_time`
|
|
1356
|
+
* - `status`
|
|
1357
|
+
* - `label`
|
|
1358
|
+
*
|
|
1359
|
+
* Supported orderings are:
|
|
1360
|
+
*
|
|
1361
|
+
* - `ASC`
|
|
1362
|
+
* - `DESC`
|
|
1363
|
+
*
|
|
1364
|
+
* @example [
|
|
1365
|
+
* "start_time ASC",
|
|
1366
|
+
* "id DESC"
|
|
1367
|
+
* ]
|
|
1368
|
+
*/
|
|
1369
|
+
orderby?: components["parameters"]["list_runs_orderby"];
|
|
1370
|
+
};
|
|
1371
|
+
header?: never;
|
|
1372
|
+
path: {
|
|
1373
|
+
/** @description The flow ID */
|
|
1374
|
+
flow_id: components["parameters"]["flow_id"];
|
|
1375
|
+
};
|
|
1376
|
+
cookie?: never;
|
|
1377
|
+
};
|
|
1378
|
+
requestBody?: never;
|
|
1379
|
+
responses: {
|
|
1380
|
+
/** @description The request was successfully received. */
|
|
1381
|
+
200: {
|
|
1382
|
+
headers: {
|
|
1383
|
+
[name: string]: unknown;
|
|
1384
|
+
};
|
|
1385
|
+
content: {
|
|
1386
|
+
"application/json": {
|
|
1387
|
+
/** @description An opaque pagination token for iterating through returned
|
|
1388
|
+
* Actions. If there are no more entries, this field will not
|
|
1389
|
+
* exist.
|
|
1390
|
+
* */
|
|
1391
|
+
marker?: string;
|
|
1392
|
+
has_next_page: boolean;
|
|
1393
|
+
actions: components["schemas"]["FlowRun"][];
|
|
1394
|
+
};
|
|
1395
|
+
};
|
|
1396
|
+
};
|
|
1397
|
+
/** @description The requestor presented a token with insufficient scopes.
|
|
1398
|
+
* */
|
|
1399
|
+
403: {
|
|
1400
|
+
headers: {
|
|
1401
|
+
[name: string]: unknown;
|
|
1402
|
+
};
|
|
1403
|
+
content?: never;
|
|
1404
|
+
};
|
|
1405
|
+
/** @description The Flow does not exist or the requestor did not have access to
|
|
1406
|
+
* enumerate the Flow's Actions.
|
|
1407
|
+
* */
|
|
1408
|
+
404: {
|
|
1409
|
+
headers: {
|
|
1410
|
+
[name: string]: unknown;
|
|
1411
|
+
};
|
|
1412
|
+
content?: never;
|
|
1413
|
+
};
|
|
1414
|
+
};
|
|
1415
|
+
};
|
|
1416
|
+
put?: never;
|
|
1417
|
+
post?: never;
|
|
1418
|
+
delete?: never;
|
|
1419
|
+
options?: never;
|
|
1420
|
+
head?: never;
|
|
1421
|
+
patch?: never;
|
|
1422
|
+
trace?: never;
|
|
1423
|
+
};
|
|
1424
|
+
"/runs": {
|
|
1425
|
+
parameters: {
|
|
1426
|
+
query?: never;
|
|
1427
|
+
header?: never;
|
|
1428
|
+
path?: never;
|
|
1429
|
+
cookie?: never;
|
|
1430
|
+
};
|
|
1431
|
+
/**
|
|
1432
|
+
* List all Runs
|
|
1433
|
+
* @description Retrieve a listing of Actions/Runs launched across all Flows. If hitting
|
|
1434
|
+
* the *\/actions endpoint, the response will list the Runs under a
|
|
1435
|
+
* "actions" key. If hitting the *\/runs endpoint, the response will list
|
|
1436
|
+
* the Runs under a "runs" key.
|
|
1437
|
+
*
|
|
1438
|
+
*/
|
|
1439
|
+
get: {
|
|
1440
|
+
parameters: {
|
|
1441
|
+
query?: {
|
|
1442
|
+
/** @description An opaque token used to iterate through pages of returned Actions.
|
|
1443
|
+
* If provided, all other query arguments will be ignored.
|
|
1444
|
+
* The marker encodes all state in a given query,
|
|
1445
|
+
* therefore it's unnecessary to provide query arguments
|
|
1446
|
+
* once an initial marker has been received.
|
|
1447
|
+
* */
|
|
1448
|
+
marker?: string;
|
|
1449
|
+
/**
|
|
1450
|
+
* @deprecated
|
|
1451
|
+
* @description ("marker" is now the preferred name for this parameter.)
|
|
1452
|
+
* An opaque token used to iterate through pages of returned Actions. If
|
|
1453
|
+
* provided, all other query arguments will be ignored. The
|
|
1454
|
+
* pagination_token encodes all state in a given query, therefore it's
|
|
1455
|
+
* unnecessary to provide query arguments once an initial token has been
|
|
1456
|
+
* received.
|
|
1457
|
+
*
|
|
1458
|
+
*/
|
|
1459
|
+
pagination_token?: string;
|
|
1460
|
+
/**
|
|
1461
|
+
* @description The number of results to return in a single paged response.
|
|
1462
|
+
*
|
|
1463
|
+
* @example 50
|
|
1464
|
+
*/
|
|
1465
|
+
per_page?: number;
|
|
1466
|
+
/**
|
|
1467
|
+
* @description The page of results to return.
|
|
1468
|
+
* @example 2
|
|
1469
|
+
*/
|
|
1470
|
+
page?: number;
|
|
1471
|
+
/**
|
|
1472
|
+
* @description Return Runs for which the user has the supplied role. The role the
|
|
1473
|
+
* user has on the Action dictates the operations they can perform.
|
|
1474
|
+
* If multiple roles are specified, the user will have at least one of
|
|
1475
|
+
* the specified roles on each Action returned.
|
|
1476
|
+
*
|
|
1477
|
+
* @example [
|
|
1478
|
+
* "run_owner",
|
|
1479
|
+
* "run_managers"
|
|
1480
|
+
* ]
|
|
1481
|
+
*/
|
|
1482
|
+
filter_roles?: ("run_owner" | "run_managers" | "run_monitors" | "flow_run_managers" | "flow_run_monitors")[];
|
|
1483
|
+
/**
|
|
1484
|
+
* @deprecated
|
|
1485
|
+
* @description Return Runs for which the user has the provided
|
|
1486
|
+
* role. The role the user has on the Runs dictates the
|
|
1487
|
+
* operations they can perform. Roles are cumulative in the
|
|
1488
|
+
* sense that having, for example, the "run_manager" role also
|
|
1489
|
+
* implies having the "run_monitor" role. Thus, specifying
|
|
1490
|
+
* manager will also include all Runs for which the user
|
|
1491
|
+
* has "run_monitor" role as well. If not provided, only Runs
|
|
1492
|
+
* for which the caller has "run_owner" role will be returned.
|
|
1493
|
+
*
|
|
1494
|
+
* @example run_manager
|
|
1495
|
+
*/
|
|
1496
|
+
filter_role?: "run_monitor" | "run_manager" | "run_owner";
|
|
1497
|
+
/**
|
|
1498
|
+
* @description Return Actions which are in the specified state. The state of the
|
|
1499
|
+
* Action dictates the operations which can performed on them. If
|
|
1500
|
+
* multiple statuses are specified, each Action returned will be in one
|
|
1501
|
+
* of the specified states. By default, Actions in any state will be
|
|
1502
|
+
* returned.
|
|
1503
|
+
*
|
|
1504
|
+
* @example [
|
|
1505
|
+
* "FAILED",
|
|
1506
|
+
* "INACTIVE"
|
|
1507
|
+
* ]
|
|
1508
|
+
*/
|
|
1509
|
+
filter_status?: ("SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE")[];
|
|
1510
|
+
/**
|
|
1511
|
+
* @description Performs a case insensitive string based search on the Actions'
|
|
1512
|
+
* label fields. If multiple values are specified, each Action returned
|
|
1513
|
+
* is guaranteed to contain at least one of the strings in its label.
|
|
1514
|
+
*
|
|
1515
|
+
* @example [
|
|
1516
|
+
* "science",
|
|
1517
|
+
* "tests"
|
|
1518
|
+
* ]
|
|
1519
|
+
*/
|
|
1520
|
+
filter_label?: string[];
|
|
1521
|
+
/**
|
|
1522
|
+
* @description Performs a case insensitive string based search to filter for
|
|
1523
|
+
* Actions which have parent Flow's with a matching title(s). If
|
|
1524
|
+
* multiple values are specified, each Action returned will have a
|
|
1525
|
+
* parent Flow with a title matching at least one of the strings.
|
|
1526
|
+
*
|
|
1527
|
+
* @example [
|
|
1528
|
+
* "globus",
|
|
1529
|
+
* "tests"
|
|
1530
|
+
* ]
|
|
1531
|
+
*/
|
|
1532
|
+
filter_flow_title?: string[];
|
|
1533
|
+
/**
|
|
1534
|
+
* @description Performs an equality based search to filter for Runs which were
|
|
1535
|
+
* initiated from the specified Flow ID(s). If multiple values are
|
|
1536
|
+
* specified, each Run returned will have been initiated from at least
|
|
1537
|
+
* one of the specified Flow IDs.
|
|
1538
|
+
*
|
|
1539
|
+
* @example [
|
|
1540
|
+
* "00000000-19d9-4f5b-9329-22ed12d4d3dd",
|
|
1541
|
+
* "11111111-19a5-4d19-998e-0709c40321e9"
|
|
1542
|
+
* ]
|
|
1543
|
+
*/
|
|
1544
|
+
filter_flow_id?: string[];
|
|
1545
|
+
/**
|
|
1546
|
+
* @description Given a pair of comma-separated ISO 8601 datetime strings,
|
|
1547
|
+
* filter results to only those runs which completed execution
|
|
1548
|
+
* within the specified range.
|
|
1549
|
+
*
|
|
1550
|
+
* If one of the dates is omitted, it forms an open range.
|
|
1551
|
+
* For example, if the filter has a datetime followed by a comma (`"DT,"`),
|
|
1552
|
+
* all records with a date greater then or equal to `DT` will be returned.
|
|
1553
|
+
* Similarly, if the filter has a comma followed by a datetime (`",DT"`),
|
|
1554
|
+
* all records with dates less than `DT` will be returned.
|
|
1555
|
+
* If there is no comma, it is treated in the same way as `"DT,"`, above.
|
|
1556
|
+
*
|
|
1557
|
+
* Results will contain runs which completed between the first datetime
|
|
1558
|
+
* onwards, up to (but not including) the second datetime.
|
|
1559
|
+
*
|
|
1560
|
+
* Note that runs which are still executing will not have a completion time
|
|
1561
|
+
* and will be automatically excluded if this filter is applied.
|
|
1562
|
+
*
|
|
1563
|
+
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
1564
|
+
*/
|
|
1565
|
+
filter_completion_time?: components["parameters"]["filter_completion_time"];
|
|
1566
|
+
/**
|
|
1567
|
+
* @description Given a pair of comma separated ISO 8601 date/time strings,
|
|
1568
|
+
* filter results to only those runs which started execution
|
|
1569
|
+
* within the specified range.
|
|
1570
|
+
*
|
|
1571
|
+
* If one of the dates is omitted, it forms an open range.
|
|
1572
|
+
* For example, if the filter has a datetime followed by a comma (`"DT,"`),
|
|
1573
|
+
* all records with a date greater then or equal to `DT` will be returned.
|
|
1574
|
+
* Similarly, if the filter has a comma followed by a datetime (`",DT"`),
|
|
1575
|
+
* all records with dates less than `DT` will be returned.
|
|
1576
|
+
* If there is no comma, it is treated in the same way as `"DT,"`, above.
|
|
1577
|
+
*
|
|
1578
|
+
* Results will contain runs which began between the first datetime
|
|
1579
|
+
* onwards, up to (but not including) the second datetime.
|
|
1580
|
+
*
|
|
1581
|
+
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
1582
|
+
*/
|
|
1583
|
+
filter_start_time?: components["parameters"]["filter_start_time"];
|
|
1584
|
+
/**
|
|
1585
|
+
* @description Ordering criteria to apply to the list of runs.
|
|
1586
|
+
*
|
|
1587
|
+
* This field is a comma-separated list of sort criteria,
|
|
1588
|
+
* and follows this syntax:
|
|
1589
|
+
*
|
|
1590
|
+
* ```
|
|
1591
|
+
* CRITERION1[,CRITERION2[,...]]
|
|
1592
|
+
* ```
|
|
1593
|
+
*
|
|
1594
|
+
* and each individual `CRITERION` follows this syntax:
|
|
1595
|
+
*
|
|
1596
|
+
* ```
|
|
1597
|
+
* FIELD ORDERING
|
|
1598
|
+
* ```
|
|
1599
|
+
*
|
|
1600
|
+
* The first value, `FIELD`, indicates the field to sort by;
|
|
1601
|
+
* the second value, `ORDERING`, indicates the sorting order.
|
|
1602
|
+
*
|
|
1603
|
+
* When additional comma-separated criteria are added,
|
|
1604
|
+
* the first criterion will be used to sort the data;
|
|
1605
|
+
* subsequent criteria will be applied for ties.
|
|
1606
|
+
*
|
|
1607
|
+
* Supported fields are:
|
|
1608
|
+
*
|
|
1609
|
+
* - `id`
|
|
1610
|
+
* - `start_time`
|
|
1611
|
+
* - `completion_time`
|
|
1612
|
+
* - `status`
|
|
1613
|
+
* - `label`
|
|
1614
|
+
*
|
|
1615
|
+
* Supported orderings are:
|
|
1616
|
+
*
|
|
1617
|
+
* - `ASC`
|
|
1618
|
+
* - `DESC`
|
|
1619
|
+
*
|
|
1620
|
+
* @example [
|
|
1621
|
+
* "start_time ASC",
|
|
1622
|
+
* "id DESC"
|
|
1623
|
+
* ]
|
|
1624
|
+
*/
|
|
1625
|
+
orderby?: components["parameters"]["list_runs_orderby"];
|
|
1626
|
+
};
|
|
1627
|
+
header?: never;
|
|
1628
|
+
path?: never;
|
|
1629
|
+
cookie?: never;
|
|
1630
|
+
};
|
|
1631
|
+
requestBody?: never;
|
|
1632
|
+
responses: {
|
|
1633
|
+
/** @description The request was successfully received. */
|
|
1634
|
+
200: {
|
|
1635
|
+
headers: {
|
|
1636
|
+
[name: string]: unknown;
|
|
1637
|
+
};
|
|
1638
|
+
content: {
|
|
1639
|
+
"application/json": {
|
|
1640
|
+
/** @description An opaque pagination token for iterating through returned
|
|
1641
|
+
* Actions. If there are no more entries, this field will not
|
|
1642
|
+
* exist.
|
|
1643
|
+
* */
|
|
1644
|
+
marker?: string;
|
|
1645
|
+
has_next_page: boolean;
|
|
1646
|
+
actions?: components["schemas"]["FlowRun"][];
|
|
1647
|
+
runs?: components["schemas"]["FlowRun"][];
|
|
1648
|
+
};
|
|
1649
|
+
};
|
|
1650
|
+
};
|
|
1651
|
+
/** @description The requestor presented a token with insufficient scopes.
|
|
1652
|
+
* */
|
|
1653
|
+
403: {
|
|
1654
|
+
headers: {
|
|
1655
|
+
[name: string]: unknown;
|
|
1656
|
+
};
|
|
1657
|
+
content?: never;
|
|
1658
|
+
};
|
|
1659
|
+
/** @description The Flow does not exist or the requestor did not have access to
|
|
1660
|
+
* enumerate the Actions.
|
|
1661
|
+
* */
|
|
1662
|
+
404: {
|
|
1663
|
+
headers: {
|
|
1664
|
+
[name: string]: unknown;
|
|
1665
|
+
};
|
|
1666
|
+
content?: never;
|
|
1667
|
+
};
|
|
1668
|
+
};
|
|
1669
|
+
};
|
|
1670
|
+
put?: never;
|
|
1671
|
+
post?: never;
|
|
1672
|
+
delete?: never;
|
|
1673
|
+
options?: never;
|
|
1674
|
+
head?: never;
|
|
1675
|
+
patch?: never;
|
|
1676
|
+
trace?: never;
|
|
1677
|
+
};
|
|
1678
|
+
"/runs/{run_id}": {
|
|
1679
|
+
parameters: {
|
|
1680
|
+
query?: never;
|
|
1681
|
+
header?: never;
|
|
1682
|
+
path: {
|
|
1683
|
+
/** @description The run ID */
|
|
1684
|
+
run_id: components["parameters"]["run_id"];
|
|
1685
|
+
};
|
|
1686
|
+
cookie?: never;
|
|
1687
|
+
};
|
|
1688
|
+
/**
|
|
1689
|
+
* Get details about a run
|
|
1690
|
+
* @description Get details about a run.
|
|
1691
|
+
*
|
|
1692
|
+
*/
|
|
1693
|
+
get: {
|
|
1694
|
+
parameters: {
|
|
1695
|
+
query?: {
|
|
1696
|
+
/**
|
|
1697
|
+
* @description If present and set to a true value,
|
|
1698
|
+
* metadata about the associated flow will be included.
|
|
1699
|
+
*
|
|
1700
|
+
* @example true
|
|
1701
|
+
*/
|
|
1702
|
+
include_flow_description?: true | true | false | false;
|
|
1703
|
+
};
|
|
1704
|
+
header?: never;
|
|
1705
|
+
path: {
|
|
1706
|
+
/** @description The run ID */
|
|
1707
|
+
run_id: components["parameters"]["run_id"];
|
|
1708
|
+
};
|
|
1709
|
+
cookie?: never;
|
|
1710
|
+
};
|
|
1711
|
+
requestBody?: never;
|
|
1712
|
+
responses: {
|
|
1713
|
+
/** @description The request was successfully received. */
|
|
1714
|
+
200: {
|
|
1715
|
+
headers: {
|
|
1716
|
+
[name: string]: unknown;
|
|
1717
|
+
};
|
|
1718
|
+
content: {
|
|
1719
|
+
"application/json": components["schemas"]["FlowRunWithFlowEmbed"];
|
|
1720
|
+
};
|
|
1721
|
+
};
|
|
1722
|
+
/** @description The requestor presented a token with insufficient scopes.
|
|
1723
|
+
* */
|
|
1724
|
+
403: {
|
|
1725
|
+
headers: {
|
|
1726
|
+
[name: string]: unknown;
|
|
1727
|
+
};
|
|
1728
|
+
content?: never;
|
|
1729
|
+
};
|
|
1730
|
+
/** @description The Run does not exist or the requestor did not have access to
|
|
1731
|
+
* view the Run's status.
|
|
1732
|
+
* */
|
|
1733
|
+
404: {
|
|
1734
|
+
headers: {
|
|
1735
|
+
[name: string]: unknown;
|
|
1736
|
+
};
|
|
1737
|
+
content?: never;
|
|
1738
|
+
};
|
|
1739
|
+
};
|
|
1740
|
+
};
|
|
1741
|
+
/**
|
|
1742
|
+
* Update a Run's metadata
|
|
1743
|
+
* @description Modify a Run's metadata.
|
|
1744
|
+
*
|
|
1745
|
+
* By default only the Run initiator is able to modify a Run's metadata.
|
|
1746
|
+
* Note that delegating manage access to a principal will allow them
|
|
1747
|
+
* to further alter the principals with monitor and manage access.
|
|
1748
|
+
*
|
|
1749
|
+
*/
|
|
1750
|
+
put: {
|
|
1751
|
+
parameters: {
|
|
1752
|
+
query?: never;
|
|
1753
|
+
header?: never;
|
|
1754
|
+
path: {
|
|
1755
|
+
/** @description The run ID */
|
|
1756
|
+
run_id: components["parameters"]["run_id"];
|
|
1757
|
+
};
|
|
1758
|
+
cookie?: never;
|
|
1759
|
+
};
|
|
1760
|
+
requestBody: {
|
|
1761
|
+
content: {
|
|
1762
|
+
"application/json": components["schemas"]["RunUpdate"];
|
|
1763
|
+
};
|
|
1764
|
+
};
|
|
1765
|
+
responses: {
|
|
1766
|
+
/** @description The request was successfully received. */
|
|
1767
|
+
200: {
|
|
1768
|
+
headers: {
|
|
1769
|
+
[name: string]: unknown;
|
|
1770
|
+
};
|
|
1771
|
+
content: {
|
|
1772
|
+
"application/json": components["schemas"]["FlowRun"];
|
|
1773
|
+
};
|
|
1774
|
+
};
|
|
1775
|
+
/** @description The requestor presented a token with insufficient scopes.
|
|
1776
|
+
* */
|
|
1777
|
+
403: {
|
|
1778
|
+
headers: {
|
|
1779
|
+
[name: string]: unknown;
|
|
1780
|
+
};
|
|
1781
|
+
content?: never;
|
|
1782
|
+
};
|
|
1783
|
+
/** @description The Run does not exist or the requestor did not have access to
|
|
1784
|
+
* modify the Run.
|
|
1785
|
+
* */
|
|
1786
|
+
404: {
|
|
1787
|
+
headers: {
|
|
1788
|
+
[name: string]: unknown;
|
|
1789
|
+
};
|
|
1790
|
+
content?: never;
|
|
1791
|
+
};
|
|
1792
|
+
/** @description The request's JSON body did not pass schema validation.
|
|
1793
|
+
* */
|
|
1794
|
+
422: {
|
|
1795
|
+
headers: {
|
|
1796
|
+
[name: string]: unknown;
|
|
1797
|
+
};
|
|
1798
|
+
content?: never;
|
|
1799
|
+
};
|
|
1800
|
+
/** @description An upstream service has imposed rate limiting.
|
|
1801
|
+
* The requestor may resubmit the API request.
|
|
1802
|
+
* */
|
|
1803
|
+
429: {
|
|
1804
|
+
headers: {
|
|
1805
|
+
[name: string]: unknown;
|
|
1806
|
+
};
|
|
1807
|
+
content?: never;
|
|
1808
|
+
};
|
|
1809
|
+
/** @description An unknown upstream service error occurred.
|
|
1810
|
+
* The problem may be resolved by re-submitting the API request.
|
|
1811
|
+
* */
|
|
1812
|
+
502: {
|
|
1813
|
+
headers: {
|
|
1814
|
+
[name: string]: unknown;
|
|
1815
|
+
};
|
|
1816
|
+
content?: never;
|
|
1817
|
+
};
|
|
1818
|
+
};
|
|
1819
|
+
};
|
|
1820
|
+
post?: never;
|
|
1821
|
+
delete?: never;
|
|
1822
|
+
options?: never;
|
|
1823
|
+
head?: never;
|
|
1824
|
+
patch?: never;
|
|
1825
|
+
trace?: never;
|
|
1826
|
+
};
|
|
1827
|
+
"/runs/{run_id}/definition": {
|
|
1828
|
+
parameters: {
|
|
1829
|
+
query?: never;
|
|
1830
|
+
header?: never;
|
|
1831
|
+
path: {
|
|
1832
|
+
/** @description The run ID */
|
|
1833
|
+
run_id: components["parameters"]["run_id"];
|
|
1834
|
+
};
|
|
1835
|
+
cookie?: never;
|
|
1836
|
+
};
|
|
1837
|
+
/**
|
|
1838
|
+
* Get the Flow definition and input schema that were used to start a Run
|
|
1839
|
+
* @description Flow definitions and input schemas may be updated after a Run has been started.
|
|
1840
|
+
*
|
|
1841
|
+
* This route allows users to view the Flow definition and input schema
|
|
1842
|
+
* that were used to start a given Run.
|
|
1843
|
+
*
|
|
1844
|
+
*/
|
|
1845
|
+
get: {
|
|
1846
|
+
parameters: {
|
|
1847
|
+
query?: never;
|
|
1848
|
+
header?: never;
|
|
1849
|
+
path: {
|
|
1850
|
+
/** @description The run ID */
|
|
1851
|
+
run_id: components["parameters"]["run_id"];
|
|
1852
|
+
};
|
|
1853
|
+
cookie?: never;
|
|
1854
|
+
};
|
|
1855
|
+
requestBody?: never;
|
|
1856
|
+
responses: {
|
|
1857
|
+
/** @description The request was successfully received. */
|
|
1858
|
+
200: {
|
|
1859
|
+
headers: {
|
|
1860
|
+
[name: string]: unknown;
|
|
1861
|
+
};
|
|
1862
|
+
content: {
|
|
1863
|
+
"application/json": components["schemas"]["GetRunDefinitionResponse"];
|
|
1864
|
+
};
|
|
1865
|
+
};
|
|
1866
|
+
/** @description The requestor presented a token with insufficient scopes.
|
|
1867
|
+
* */
|
|
1868
|
+
403: {
|
|
1869
|
+
headers: {
|
|
1870
|
+
[name: string]: unknown;
|
|
1871
|
+
};
|
|
1872
|
+
content?: never;
|
|
1873
|
+
};
|
|
1874
|
+
/** @description The Run does not exist or the requestor did not have access to view the Run.
|
|
1875
|
+
* */
|
|
1876
|
+
404: {
|
|
1877
|
+
headers: {
|
|
1878
|
+
[name: string]: unknown;
|
|
1879
|
+
};
|
|
1880
|
+
content?: never;
|
|
1881
|
+
};
|
|
1882
|
+
};
|
|
1883
|
+
};
|
|
1884
|
+
put?: never;
|
|
1885
|
+
post?: never;
|
|
1886
|
+
delete?: never;
|
|
1887
|
+
options?: never;
|
|
1888
|
+
head?: never;
|
|
1889
|
+
patch?: never;
|
|
1890
|
+
trace?: never;
|
|
1891
|
+
};
|
|
1892
|
+
"/batch/runs": {
|
|
1893
|
+
parameters: {
|
|
1894
|
+
query?: never;
|
|
1895
|
+
header?: never;
|
|
1896
|
+
path?: never;
|
|
1897
|
+
cookie?: never;
|
|
1898
|
+
};
|
|
1899
|
+
get?: never;
|
|
1900
|
+
put?: never;
|
|
1901
|
+
/** Update metadata for multiple Runs. */
|
|
1902
|
+
post: {
|
|
1903
|
+
parameters: {
|
|
1904
|
+
query?: never;
|
|
1905
|
+
header?: never;
|
|
1906
|
+
path?: never;
|
|
1907
|
+
cookie?: never;
|
|
1908
|
+
};
|
|
1909
|
+
requestBody: {
|
|
1910
|
+
content: {
|
|
1911
|
+
"application/json": {
|
|
1912
|
+
filters: {
|
|
1913
|
+
run_ids: string[];
|
|
1914
|
+
};
|
|
1915
|
+
set?: components["schemas"]["BatchRunUpdateSetOperation"];
|
|
1916
|
+
add?: components["schemas"]["BatchRunUpdateOperation"];
|
|
1917
|
+
remove?: components["schemas"]["BatchRunUpdateOperation"];
|
|
1918
|
+
};
|
|
1919
|
+
};
|
|
1920
|
+
};
|
|
1921
|
+
responses: {
|
|
1922
|
+
202: components["responses"]["HTTP202Response"];
|
|
1923
|
+
403: components["responses"]["HTTP403Response"];
|
|
1924
|
+
422: components["responses"]["HTTP422Response"];
|
|
1925
|
+
};
|
|
1926
|
+
};
|
|
1927
|
+
delete?: never;
|
|
1928
|
+
options?: never;
|
|
1929
|
+
head?: never;
|
|
1930
|
+
patch?: never;
|
|
1931
|
+
trace?: never;
|
|
1932
|
+
};
|
|
1933
|
+
}
|
|
1934
|
+
export type webhooks = Record<string, never>;
|
|
1935
|
+
export interface components {
|
|
1936
|
+
schemas: {
|
|
1937
|
+
/**
|
|
1938
|
+
* The flow definition
|
|
1939
|
+
* @description The flow definition.
|
|
1940
|
+
*
|
|
1941
|
+
* If this parameter is used when updating a flow,
|
|
1942
|
+
* runs that are currently executing will continue to use the definition
|
|
1943
|
+
* that they were initially started with.
|
|
1944
|
+
*
|
|
1945
|
+
*/
|
|
1946
|
+
FlowDefinition: {
|
|
1947
|
+
Comment?: string;
|
|
1948
|
+
StartAt: string;
|
|
1949
|
+
States: {
|
|
1950
|
+
[key: string]: components["schemas"]["Pass"] | components["schemas"]["Action"] | components["schemas"]["Wait"] | components["schemas"]["Choice"] | components["schemas"]["ExpressionEval"] | components["schemas"]["Fail"];
|
|
1951
|
+
};
|
|
1952
|
+
};
|
|
1953
|
+
FlowRun: {
|
|
1954
|
+
/** @description The ID for a particular Flow invocation. Analogous to a run_id.
|
|
1955
|
+
* */
|
|
1956
|
+
action_id: string;
|
|
1957
|
+
/** @description The ID for a particular Flow invocation. Analogous to an action_id.
|
|
1958
|
+
* */
|
|
1959
|
+
run_id: string;
|
|
1960
|
+
/** @description The Flow to which this Run belongs.
|
|
1961
|
+
* */
|
|
1962
|
+
flow_id: string;
|
|
1963
|
+
/**
|
|
1964
|
+
* Format: date-time
|
|
1965
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
1966
|
+
* which the last update to this Run's Flow occurred.
|
|
1967
|
+
*
|
|
1968
|
+
*/
|
|
1969
|
+
flow_last_updated: string;
|
|
1970
|
+
/**
|
|
1971
|
+
* Format: date-time
|
|
1972
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
1973
|
+
* which this Run started.
|
|
1974
|
+
*
|
|
1975
|
+
*/
|
|
1976
|
+
start_time: string;
|
|
1977
|
+
/**
|
|
1978
|
+
* Format: date-time
|
|
1979
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
1980
|
+
* which this Run reached a completed status.
|
|
1981
|
+
*
|
|
1982
|
+
*/
|
|
1983
|
+
completion_time: string;
|
|
1984
|
+
label: components["schemas"]["Label"];
|
|
1985
|
+
/**
|
|
1986
|
+
* @description The current state of the Run.
|
|
1987
|
+
* @enum {string}
|
|
1988
|
+
*/
|
|
1989
|
+
status: "SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE";
|
|
1990
|
+
display_status?: string;
|
|
1991
|
+
/** @description Details about the run execution. This is null for runs of High Assurance
|
|
1992
|
+
* flows when listing runs.
|
|
1993
|
+
* */
|
|
1994
|
+
details: Record<string, unknown> | null;
|
|
1995
|
+
run_owner: components["schemas"]["PrincipalURN"];
|
|
1996
|
+
run_monitors?: components["schemas"]["RunMonitors"];
|
|
1997
|
+
run_managers?: components["schemas"]["RunManagers"];
|
|
1998
|
+
/**
|
|
1999
|
+
* @description The role the requesting user has on the Run.
|
|
2000
|
+
*
|
|
2001
|
+
* @enum {string}
|
|
2002
|
+
*/
|
|
2003
|
+
user_role: "run_monitor" | "run_manager" | "run_owner";
|
|
2004
|
+
tags: components["schemas"]["Tags"];
|
|
2005
|
+
};
|
|
2006
|
+
ValidateRun: {
|
|
2007
|
+
/**
|
|
2008
|
+
* @description A message indicating the validation was successful
|
|
2009
|
+
*
|
|
2010
|
+
* @example success
|
|
2011
|
+
*/
|
|
2012
|
+
message: string;
|
|
2013
|
+
};
|
|
2014
|
+
GetRunDefinitionResponse: {
|
|
2015
|
+
/** @description The Flow used to start the Run.
|
|
2016
|
+
* */
|
|
2017
|
+
flow_id: string;
|
|
2018
|
+
/** @description The definition of the Flow at the time the Run was started.
|
|
2019
|
+
* */
|
|
2020
|
+
definition: Record<string, unknown>;
|
|
2021
|
+
/** @description The input schema of the Flow at the time the Run was started.
|
|
2022
|
+
* */
|
|
2023
|
+
input_schema: Record<string, unknown>;
|
|
2024
|
+
};
|
|
2025
|
+
FlowEmbed: {
|
|
2026
|
+
/** @description The unique identifier for the Flow. */
|
|
2027
|
+
id: string;
|
|
2028
|
+
flow_owner?: components["schemas"]["PrincipalURN"];
|
|
2029
|
+
/**
|
|
2030
|
+
* Format: date-time
|
|
2031
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2032
|
+
* which the Flow was created.
|
|
2033
|
+
*
|
|
2034
|
+
*/
|
|
2035
|
+
created_at: string;
|
|
2036
|
+
/**
|
|
2037
|
+
* Format: date-time
|
|
2038
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2039
|
+
* which the Flow was last updated.
|
|
2040
|
+
*
|
|
2041
|
+
*/
|
|
2042
|
+
updated_at?: string;
|
|
2043
|
+
/**
|
|
2044
|
+
* Format: date-time
|
|
2045
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2046
|
+
* which the Flow was deleted (not present if the Flow has not been deleted).
|
|
2047
|
+
*
|
|
2048
|
+
*/
|
|
2049
|
+
deleted_at?: string;
|
|
2050
|
+
/** @description A non-unique, human-friendly name used for displaying the Flow to end users.
|
|
2051
|
+
* */
|
|
2052
|
+
title: string;
|
|
2053
|
+
/** @description A concise summary of the Flow's purpose. */
|
|
2054
|
+
subtitle?: string;
|
|
2055
|
+
/** @description A detailed description of the Flow for end user display. */
|
|
2056
|
+
description?: string;
|
|
2057
|
+
/** @description A set of terms used to categorize the Flow which may be used in
|
|
2058
|
+
* query and discovery operations.
|
|
2059
|
+
* */
|
|
2060
|
+
keywords?: string[];
|
|
2061
|
+
};
|
|
2062
|
+
FlowRunWithFlowEmbed: components["schemas"]["FlowRun"] & {
|
|
2063
|
+
flow_description?: components["schemas"]["FlowEmbed"];
|
|
2064
|
+
};
|
|
2065
|
+
RunUpdate: {
|
|
2066
|
+
label?: components["schemas"]["Label"];
|
|
2067
|
+
run_monitors?: components["schemas"]["RunMonitors"];
|
|
2068
|
+
run_managers?: components["schemas"]["RunManagers"];
|
|
2069
|
+
tags?: components["schemas"]["Tags"];
|
|
2070
|
+
};
|
|
2071
|
+
/**
|
|
2072
|
+
* Activity notification policy
|
|
2073
|
+
* @description The email notification policy for the run.
|
|
2074
|
+
*/
|
|
2075
|
+
ActivityNotificationPolicy: {
|
|
2076
|
+
/**
|
|
2077
|
+
* @description The set of statuses on which to notify the run's owner by email.
|
|
2078
|
+
*
|
|
2079
|
+
* @default [
|
|
2080
|
+
* "INACTIVE"
|
|
2081
|
+
* ]
|
|
2082
|
+
*/
|
|
2083
|
+
status: ("INACTIVE" | "FAILED" | "SUCCEEDED")[];
|
|
2084
|
+
};
|
|
2085
|
+
/**
|
|
2086
|
+
* Input body
|
|
2087
|
+
* @description The input body that will be passed into the flow when it starts.
|
|
2088
|
+
* If the flow defines an input schema, the input body will be validated against the input schema.
|
|
2089
|
+
* If there is no input schema, no validation will be performed.
|
|
2090
|
+
*/
|
|
2091
|
+
InputBody: {
|
|
2092
|
+
[key: string]: unknown;
|
|
2093
|
+
};
|
|
2094
|
+
/**
|
|
2095
|
+
* Label
|
|
2096
|
+
* @description A short, human-readable description of the run.
|
|
2097
|
+
* @example Generate a report for experiment xDA202-batch-3
|
|
2098
|
+
*/
|
|
2099
|
+
Label: string;
|
|
2100
|
+
/**
|
|
2101
|
+
* Run managers
|
|
2102
|
+
* @description A list of Globus Auth identity and group URNs that may manage runs of the flow.
|
|
2103
|
+
*
|
|
2104
|
+
* "Managing" operations include updating, canceling, and deleting the run.
|
|
2105
|
+
*
|
|
2106
|
+
* Only users with the "run_manager" role will be able to view this list.
|
|
2107
|
+
* Users with only the "run_monitor" role will see an empty list.
|
|
2108
|
+
*
|
|
2109
|
+
*/
|
|
2110
|
+
RunManagers: components["schemas"]["PrincipalURN"][];
|
|
2111
|
+
/**
|
|
2112
|
+
* Run monitors
|
|
2113
|
+
* @description A list of Globus Auth identity and group URNs that may monitor runs of the flow.
|
|
2114
|
+
*
|
|
2115
|
+
* "Monitoring" operations include checking the run status and its logs.
|
|
2116
|
+
*
|
|
2117
|
+
* Only users with the "run_manager" role will be able to view this list.
|
|
2118
|
+
* Users with only the "run_monitor" role will see an empty list.
|
|
2119
|
+
*
|
|
2120
|
+
*/
|
|
2121
|
+
RunMonitors: components["schemas"]["PrincipalURN"][];
|
|
2122
|
+
/**
|
|
2123
|
+
* Tags
|
|
2124
|
+
* @description A list of tags to associate with the run.
|
|
2125
|
+
*
|
|
2126
|
+
* Tags are normalized by stripping leading and trailing whitespace,
|
|
2127
|
+
* and by replacing all whitespace with a single space.
|
|
2128
|
+
*
|
|
2129
|
+
* When updating a run, existing tags will be overwritten.
|
|
2130
|
+
* This means that an empty array will delete all existing tags.
|
|
2131
|
+
*
|
|
2132
|
+
* @example [
|
|
2133
|
+
* "Experiment:xDA202",
|
|
2134
|
+
* "Site:Nautilus",
|
|
2135
|
+
* "Friday COB Report"
|
|
2136
|
+
* ]
|
|
2137
|
+
*/
|
|
2138
|
+
Tags: string[];
|
|
2139
|
+
/**
|
|
2140
|
+
* @description A URN representation of an Identity in Globus either of a user from
|
|
2141
|
+
* Globus Auth or a group from Globus Groups.
|
|
2142
|
+
*
|
|
2143
|
+
* @example urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c
|
|
2144
|
+
*/
|
|
2145
|
+
PrincipalURN: string;
|
|
2146
|
+
JsonPathPattern: string;
|
|
2147
|
+
NextOrEnd: {
|
|
2148
|
+
Next?: string;
|
|
2149
|
+
End?: boolean;
|
|
2150
|
+
} & (unknown | unknown);
|
|
2151
|
+
Parameters: {
|
|
2152
|
+
Parameters?: {
|
|
2153
|
+
[key: string]: unknown;
|
|
2154
|
+
};
|
|
2155
|
+
};
|
|
2156
|
+
InputPath: {
|
|
2157
|
+
InputPath?: components["schemas"]["JsonPathPattern"];
|
|
2158
|
+
};
|
|
2159
|
+
ResultPath: {
|
|
2160
|
+
ResultPath?: components["schemas"]["JsonPathPattern"];
|
|
2161
|
+
};
|
|
2162
|
+
ParametersOrInputPathNotRequired: components["schemas"]["Parameters"] & components["schemas"]["InputPath"];
|
|
2163
|
+
ParametersOrInputPath: (components["schemas"]["Parameters"] & components["schemas"]["InputPath"]) & (unknown | unknown);
|
|
2164
|
+
Pass: {
|
|
2165
|
+
Type?: string;
|
|
2166
|
+
Comment?: unknown;
|
|
2167
|
+
Next?: unknown;
|
|
2168
|
+
End?: unknown;
|
|
2169
|
+
InputPath?: unknown;
|
|
2170
|
+
Parameters?: unknown;
|
|
2171
|
+
ResultPath?: unknown;
|
|
2172
|
+
} & components["schemas"]["NextOrEnd"] & components["schemas"]["ParametersOrInputPathNotRequired"] & components["schemas"]["ResultPath"];
|
|
2173
|
+
Catch: {
|
|
2174
|
+
Catch?: ({
|
|
2175
|
+
ErrorEquals: string[];
|
|
2176
|
+
Next: string;
|
|
2177
|
+
ResultPath?: unknown;
|
|
2178
|
+
} & components["schemas"]["ResultPath"])[];
|
|
2179
|
+
};
|
|
2180
|
+
Action: {
|
|
2181
|
+
/** Format: uri */
|
|
2182
|
+
ActionUrl: string;
|
|
2183
|
+
/** Format: uri */
|
|
2184
|
+
ActionScope?: string;
|
|
2185
|
+
RunAs?: string;
|
|
2186
|
+
/** @default false */
|
|
2187
|
+
ExceptionOnActionFailure: boolean;
|
|
2188
|
+
WaitTime?: number;
|
|
2189
|
+
Type: string;
|
|
2190
|
+
Comment?: unknown;
|
|
2191
|
+
Next?: unknown;
|
|
2192
|
+
End?: unknown;
|
|
2193
|
+
InputPath?: unknown;
|
|
2194
|
+
Parameters?: unknown;
|
|
2195
|
+
ResultPath?: unknown;
|
|
2196
|
+
Catch?: unknown;
|
|
2197
|
+
} & components["schemas"]["NextOrEnd"] & components["schemas"]["ParametersOrInputPath"] & components["schemas"]["ResultPath"] & components["schemas"]["Catch"];
|
|
2198
|
+
ExpressionEval: {
|
|
2199
|
+
Type?: string;
|
|
2200
|
+
Comment?: unknown;
|
|
2201
|
+
Parameters: unknown;
|
|
2202
|
+
ResultPath: unknown;
|
|
2203
|
+
Next: string;
|
|
2204
|
+
} & components["schemas"]["Parameters"] & components["schemas"]["ResultPath"];
|
|
2205
|
+
Wait: {
|
|
2206
|
+
Type?: string;
|
|
2207
|
+
Comment?: unknown;
|
|
2208
|
+
Next?: string;
|
|
2209
|
+
Seconds?: number;
|
|
2210
|
+
SecondsPath?: components["schemas"]["JsonPathPattern"];
|
|
2211
|
+
/** Format: date-time */
|
|
2212
|
+
Timestamp?: string;
|
|
2213
|
+
TimestampPath?: components["schemas"]["JsonPathPattern"];
|
|
2214
|
+
} & (unknown | unknown | unknown | unknown);
|
|
2215
|
+
ChoiceRule: {
|
|
2216
|
+
And?: components["schemas"]["ChoiceRule"][];
|
|
2217
|
+
Or?: components["schemas"]["ChoiceRule"][];
|
|
2218
|
+
Not?: components["schemas"]["ChoiceRule"];
|
|
2219
|
+
Variable?: string;
|
|
2220
|
+
StringEquals?: string;
|
|
2221
|
+
StringEqualsPath?: components["schemas"]["JsonPathPattern"];
|
|
2222
|
+
StringLessThan?: string;
|
|
2223
|
+
StringLessThanPath?: components["schemas"]["JsonPathPattern"];
|
|
2224
|
+
StringGreaterThan?: string;
|
|
2225
|
+
StringGreaterThanPath?: components["schemas"]["JsonPathPattern"];
|
|
2226
|
+
StringLessThanEquals?: string;
|
|
2227
|
+
StringLessThanEqualsPath?: components["schemas"]["JsonPathPattern"];
|
|
2228
|
+
StringGreaterThanEquals?: string;
|
|
2229
|
+
StringGreaterThanEqualsPath?: components["schemas"]["JsonPathPattern"];
|
|
2230
|
+
StringMatches?: string;
|
|
2231
|
+
NumericEquals?: number;
|
|
2232
|
+
NumericEqualsPath?: components["schemas"]["JsonPathPattern"];
|
|
2233
|
+
NumericLessThan?: number;
|
|
2234
|
+
NumericLessThanPath?: components["schemas"]["JsonPathPattern"];
|
|
2235
|
+
NumericGreaterThan?: number;
|
|
2236
|
+
NumericGreaterThanPath?: components["schemas"]["JsonPathPattern"];
|
|
2237
|
+
NumericLessThanEquals?: number;
|
|
2238
|
+
NumericLessThanEqualsPath?: components["schemas"]["JsonPathPattern"];
|
|
2239
|
+
NumericGreaterThanEquals?: number;
|
|
2240
|
+
NumericGreaterThanEqualsPath?: components["schemas"]["JsonPathPattern"];
|
|
2241
|
+
BooleanEquals?: boolean;
|
|
2242
|
+
BooleanEqualsPath?: components["schemas"]["JsonPathPattern"];
|
|
2243
|
+
/** Format: date-time */
|
|
2244
|
+
TimestampEquals?: string;
|
|
2245
|
+
TimestampEqualsPath?: components["schemas"]["JsonPathPattern"];
|
|
2246
|
+
/** Format: date-time */
|
|
2247
|
+
TimestampLessThan?: string;
|
|
2248
|
+
TimestampLessThanPath?: components["schemas"]["JsonPathPattern"];
|
|
2249
|
+
/** Format: date-time */
|
|
2250
|
+
TimestampGreaterThan?: string;
|
|
2251
|
+
TimestampGreaterThanPath?: components["schemas"]["JsonPathPattern"];
|
|
2252
|
+
/** Format: date-time */
|
|
2253
|
+
TimestampLessThanEquals?: string;
|
|
2254
|
+
TimestampLessThanEqualsPath?: components["schemas"]["JsonPathPattern"];
|
|
2255
|
+
/** Format: date-time */
|
|
2256
|
+
TimestampGreaterThanEquals?: string;
|
|
2257
|
+
TimestampGreaterThanEqualsPath?: components["schemas"]["JsonPathPattern"];
|
|
2258
|
+
IsNull?: boolean;
|
|
2259
|
+
IsPresent?: boolean;
|
|
2260
|
+
IsNumeric?: boolean;
|
|
2261
|
+
IsString?: boolean;
|
|
2262
|
+
IsBoolean?: boolean;
|
|
2263
|
+
IsTimestamp?: boolean;
|
|
2264
|
+
} & (unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown | unknown);
|
|
2265
|
+
Choice: {
|
|
2266
|
+
Type?: string;
|
|
2267
|
+
Comment?: string;
|
|
2268
|
+
Default?: string;
|
|
2269
|
+
Choices: ({
|
|
2270
|
+
Next?: string;
|
|
2271
|
+
} & components["schemas"]["ChoiceRule"])[];
|
|
2272
|
+
};
|
|
2273
|
+
Fail: {
|
|
2274
|
+
Type?: string;
|
|
2275
|
+
Comment?: string;
|
|
2276
|
+
Cause?: string;
|
|
2277
|
+
Error?: string;
|
|
2278
|
+
};
|
|
2279
|
+
FlowResponse: {
|
|
2280
|
+
/** @description The unique identifier for the Flow. */
|
|
2281
|
+
id?: string;
|
|
2282
|
+
/** @description The flow definition. This is null for High Assurance flows when listing flows.
|
|
2283
|
+
* */
|
|
2284
|
+
definition?: components["schemas"]["FlowDefinition"];
|
|
2285
|
+
/** @description A JSON Schema compliant definition of the format of the `body` field
|
|
2286
|
+
* when requesting a Flow be run. This is null for High Assurance flows when listing flows.
|
|
2287
|
+
* */
|
|
2288
|
+
input_schema?: Record<string, unknown> | null;
|
|
2289
|
+
/**
|
|
2290
|
+
* Format: uri
|
|
2291
|
+
* @description The scope of any bearer token to be used on authenticated accesses
|
|
2292
|
+
* to the Flow.
|
|
2293
|
+
*
|
|
2294
|
+
*/
|
|
2295
|
+
globus_auth_scope?: string;
|
|
2296
|
+
/** @description A list of scopes according to RunAs values as defined in the Flow.
|
|
2297
|
+
* */
|
|
2298
|
+
globus_auth_scopes_by_RunAs?: string[];
|
|
2299
|
+
/**
|
|
2300
|
+
* @description The role the requesting user has on the Flow.
|
|
2301
|
+
*
|
|
2302
|
+
* @enum {string}
|
|
2303
|
+
*/
|
|
2304
|
+
user_role?: "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner";
|
|
2305
|
+
/**
|
|
2306
|
+
* @description A set of Principal URN values, or the value "public"
|
|
2307
|
+
* indicating the identity of users who can view the Flow
|
|
2308
|
+
* definition. Only calling users with the "administrator"
|
|
2309
|
+
* role will be provided this list. Otherwise, the value
|
|
2310
|
+
* will always be an empty list.
|
|
2311
|
+
*
|
|
2312
|
+
* @example [
|
|
2313
|
+
* "public",
|
|
2314
|
+
* "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
|
|
2315
|
+
* "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
|
|
2316
|
+
* ]
|
|
2317
|
+
*/
|
|
2318
|
+
flow_viewers?: components["schemas"]["PrincipalURN"][];
|
|
2319
|
+
/**
|
|
2320
|
+
* @description A set of Principal URN values, or the value
|
|
2321
|
+
* "all_authenticated_users" indicating the identity of users
|
|
2322
|
+
* who can initiate a run of the Flow. Only calling users
|
|
2323
|
+
* with the "administrator" role will be provided this
|
|
2324
|
+
* list. Otherwise, the value will always be an empty list.
|
|
2325
|
+
*
|
|
2326
|
+
* @example [
|
|
2327
|
+
* "all_authenticated_users",
|
|
2328
|
+
* "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
|
|
2329
|
+
* "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
|
|
2330
|
+
* ]
|
|
2331
|
+
*/
|
|
2332
|
+
flow_starters?: components["schemas"]["PrincipalURN"][];
|
|
2333
|
+
/** @description The set of Principal URN values of users who may perform
|
|
2334
|
+
* administrative operations, including updating the
|
|
2335
|
+
* description itself. Only calling users with the
|
|
2336
|
+
* "administrator" role will be provided this
|
|
2337
|
+
* list. Otherwise, the value will always be an empty list.
|
|
2338
|
+
* */
|
|
2339
|
+
flow_administrators?: components["schemas"]["PrincipalURN"][];
|
|
2340
|
+
flow_owner?: components["schemas"]["PrincipalURN"];
|
|
2341
|
+
/**
|
|
2342
|
+
* Format: date-time
|
|
2343
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2344
|
+
* which the Flow was created.
|
|
2345
|
+
*
|
|
2346
|
+
*/
|
|
2347
|
+
created_at?: string;
|
|
2348
|
+
/**
|
|
2349
|
+
* Format: date-time
|
|
2350
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2351
|
+
* which the Flow was last updated.
|
|
2352
|
+
*
|
|
2353
|
+
*/
|
|
2354
|
+
updated_at?: string;
|
|
2355
|
+
synchronous?: boolean;
|
|
2356
|
+
/** @description True if the Flow supports the /log operation providing detailed
|
|
2357
|
+
* information on the intermediate states of a Flow invocation.
|
|
2358
|
+
* */
|
|
2359
|
+
log_supported?: boolean;
|
|
2360
|
+
types?: ("Action" | "Event")[];
|
|
2361
|
+
/** @enum {string} */
|
|
2362
|
+
api_version?: "1.0";
|
|
2363
|
+
/** @description A non-unique, human-friendly name used for displaying the Flow
|
|
2364
|
+
* to end users.
|
|
2365
|
+
* */
|
|
2366
|
+
title?: string;
|
|
2367
|
+
/** @description A concise summary of the Flow's purpose. */
|
|
2368
|
+
subtitle?: string;
|
|
2369
|
+
/** @description A detailed description of the Flow for end user display. */
|
|
2370
|
+
description?: string;
|
|
2371
|
+
/** @description A set of terms used to categorize the Flow which may be used in
|
|
2372
|
+
* query and discovery operations.
|
|
2373
|
+
* */
|
|
2374
|
+
keywords?: string[];
|
|
2375
|
+
principal_urn?: components["schemas"]["PrincipalURN"];
|
|
2376
|
+
/** @description The Flow's Globus Auth username. */
|
|
2377
|
+
globus_auth_username?: string;
|
|
2378
|
+
/**
|
|
2379
|
+
* Format: uri
|
|
2380
|
+
* @description The web-addressable location at which this Flow can be referenced
|
|
2381
|
+
* and run from.
|
|
2382
|
+
*
|
|
2383
|
+
*/
|
|
2384
|
+
flow_url?: string;
|
|
2385
|
+
/** @description Indicates whether this flow is High Assurance. High Assurance flows have
|
|
2386
|
+
* sensitive fields (definition, input_schema) omitted from list responses
|
|
2387
|
+
* for security purposes.
|
|
2388
|
+
* */
|
|
2389
|
+
is_high_assurance?: boolean;
|
|
2390
|
+
/**
|
|
2391
|
+
* Format: uuid
|
|
2392
|
+
* @description A subscription_id associated with this Flow. If no
|
|
2393
|
+
* subscription_id is present, the Flow may be
|
|
2394
|
+
* accepted, but may have limits on how long or how
|
|
2395
|
+
* much it can be used.
|
|
2396
|
+
*
|
|
2397
|
+
*/
|
|
2398
|
+
subscription_id?: string;
|
|
2399
|
+
};
|
|
2400
|
+
FlowValidationResponse: {
|
|
2401
|
+
scopes?: components["schemas"]["FlowScopes"];
|
|
2402
|
+
};
|
|
2403
|
+
FlowValidationErrorResponse: {
|
|
2404
|
+
/** @description A unique identifier for the validation error, used for debugging.
|
|
2405
|
+
* */
|
|
2406
|
+
debug_id: string;
|
|
2407
|
+
error: {
|
|
2408
|
+
/** @description A readable keyword describing the failure. */
|
|
2409
|
+
code: string;
|
|
2410
|
+
/** An array of failure objects, describing what failed. */
|
|
2411
|
+
detail: string | components["schemas"]["LocationErrorList"];
|
|
2412
|
+
/** @description A human-readable message providing more context about the failure. */
|
|
2413
|
+
message?: string;
|
|
2414
|
+
};
|
|
2415
|
+
};
|
|
2416
|
+
LocationErrorList: {
|
|
2417
|
+
/** The path of object keys that led to the validation failure. */
|
|
2418
|
+
loc: string[];
|
|
2419
|
+
/** A readable description of the validation failure. */
|
|
2420
|
+
msg: string;
|
|
2421
|
+
/** A readable failure category. */
|
|
2422
|
+
type: string;
|
|
2423
|
+
}[];
|
|
2424
|
+
FlowScopes: {
|
|
2425
|
+
[key: string]: string[];
|
|
2426
|
+
};
|
|
2427
|
+
BatchRunUpdateOperation: {
|
|
2428
|
+
tags?: string[];
|
|
2429
|
+
run_managers?: components["schemas"]["PrincipalURN"][];
|
|
2430
|
+
run_monitors?: components["schemas"]["PrincipalURN"][];
|
|
2431
|
+
};
|
|
2432
|
+
BatchRunUpdateSetOperation: {
|
|
2433
|
+
tags?: string[];
|
|
2434
|
+
run_managers?: components["schemas"]["PrincipalURN"][];
|
|
2435
|
+
run_monitors?: components["schemas"]["PrincipalURN"][];
|
|
2436
|
+
/** @enum {string} */
|
|
2437
|
+
status?: "cancel";
|
|
2438
|
+
};
|
|
2439
|
+
};
|
|
2440
|
+
responses: {
|
|
2441
|
+
/** @description The requested operation was accepted.
|
|
2442
|
+
*
|
|
2443
|
+
* The operation may have been completed, or may be completed at a later time.
|
|
2444
|
+
* A follow-up API request may be needed to confirm the status of the operation.
|
|
2445
|
+
* */
|
|
2446
|
+
HTTP202Response: {
|
|
2447
|
+
headers: {
|
|
2448
|
+
[name: string]: unknown;
|
|
2449
|
+
};
|
|
2450
|
+
content: {
|
|
2451
|
+
"application/json": Record<string, unknown>;
|
|
2452
|
+
};
|
|
2453
|
+
};
|
|
2454
|
+
/** @description The requesting user is not authorized to make the requested changes. */
|
|
2455
|
+
HTTP403Response: {
|
|
2456
|
+
headers: {
|
|
2457
|
+
[name: string]: unknown;
|
|
2458
|
+
};
|
|
2459
|
+
content: {
|
|
2460
|
+
"application/json": {
|
|
2461
|
+
error: {
|
|
2462
|
+
/** A readable keyword describing the failure. */
|
|
2463
|
+
code: string;
|
|
2464
|
+
/** A readable description of the failure. */
|
|
2465
|
+
detail: string;
|
|
2466
|
+
};
|
|
2467
|
+
};
|
|
2468
|
+
};
|
|
2469
|
+
};
|
|
2470
|
+
/** @description The input document failed input validation in some way. */
|
|
2471
|
+
HTTP422Response: {
|
|
2472
|
+
headers: {
|
|
2473
|
+
[name: string]: unknown;
|
|
2474
|
+
};
|
|
2475
|
+
content: {
|
|
2476
|
+
"application/json": {
|
|
2477
|
+
error: {
|
|
2478
|
+
/** A readable keyword describing the failure. */
|
|
2479
|
+
code: string;
|
|
2480
|
+
detail: components["schemas"]["LocationErrorList"];
|
|
2481
|
+
};
|
|
2482
|
+
};
|
|
2483
|
+
};
|
|
2484
|
+
};
|
|
2485
|
+
};
|
|
2486
|
+
parameters: {
|
|
2487
|
+
/** @description The flow ID */
|
|
2488
|
+
flow_id: string;
|
|
2489
|
+
/** @description The run ID */
|
|
2490
|
+
run_id: string;
|
|
2491
|
+
/**
|
|
2492
|
+
* @description Given a pair of comma-separated ISO 8601 datetime strings,
|
|
2493
|
+
* filter results to only those runs which completed execution
|
|
2494
|
+
* within the specified range.
|
|
2495
|
+
*
|
|
2496
|
+
* If one of the dates is omitted, it forms an open range.
|
|
2497
|
+
* For example, if the filter has a datetime followed by a comma (`"DT,"`),
|
|
2498
|
+
* all records with a date greater then or equal to `DT` will be returned.
|
|
2499
|
+
* Similarly, if the filter has a comma followed by a datetime (`",DT"`),
|
|
2500
|
+
* all records with dates less than `DT` will be returned.
|
|
2501
|
+
* If there is no comma, it is treated in the same way as `"DT,"`, above.
|
|
2502
|
+
*
|
|
2503
|
+
* Results will contain runs which completed between the first datetime
|
|
2504
|
+
* onwards, up to (but not including) the second datetime.
|
|
2505
|
+
*
|
|
2506
|
+
* Note that runs which are still executing will not have a completion time
|
|
2507
|
+
* and will be automatically excluded if this filter is applied.
|
|
2508
|
+
*
|
|
2509
|
+
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
2510
|
+
*/
|
|
2511
|
+
filter_completion_time: string;
|
|
2512
|
+
/**
|
|
2513
|
+
* @description Given a pair of comma separated ISO 8601 date/time strings,
|
|
2514
|
+
* filter results to only those runs which started execution
|
|
2515
|
+
* within the specified range.
|
|
2516
|
+
*
|
|
2517
|
+
* If one of the dates is omitted, it forms an open range.
|
|
2518
|
+
* For example, if the filter has a datetime followed by a comma (`"DT,"`),
|
|
2519
|
+
* all records with a date greater then or equal to `DT` will be returned.
|
|
2520
|
+
* Similarly, if the filter has a comma followed by a datetime (`",DT"`),
|
|
2521
|
+
* all records with dates less than `DT` will be returned.
|
|
2522
|
+
* If there is no comma, it is treated in the same way as `"DT,"`, above.
|
|
2523
|
+
*
|
|
2524
|
+
* Results will contain runs which began between the first datetime
|
|
2525
|
+
* onwards, up to (but not including) the second datetime.
|
|
2526
|
+
*
|
|
2527
|
+
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
2528
|
+
*/
|
|
2529
|
+
filter_start_time: string;
|
|
2530
|
+
/**
|
|
2531
|
+
* @description Ordering criteria to apply to the list of flows.
|
|
2532
|
+
*
|
|
2533
|
+
* This field is a comma-separated list of sort criteria,
|
|
2534
|
+
* and follows this syntax:
|
|
2535
|
+
*
|
|
2536
|
+
* ```
|
|
2537
|
+
* CRITERION1[,CRITERION2[,...]]
|
|
2538
|
+
* ```
|
|
2539
|
+
*
|
|
2540
|
+
* and each individual `CRITERION` follows this syntax:
|
|
2541
|
+
*
|
|
2542
|
+
* ```
|
|
2543
|
+
* FIELD ORDERING
|
|
2544
|
+
* ```
|
|
2545
|
+
*
|
|
2546
|
+
* The first value, `FIELD`, indicates the field to sort by;
|
|
2547
|
+
* the second value, `ORDERING`, indicates the sorting order.
|
|
2548
|
+
*
|
|
2549
|
+
* When additional comma-separated criteria are added,
|
|
2550
|
+
* the first criterion will be used to sort the data;
|
|
2551
|
+
* subsequent criteria will be applied for ties.
|
|
2552
|
+
*
|
|
2553
|
+
* Supported fields are:
|
|
2554
|
+
*
|
|
2555
|
+
* - `id`
|
|
2556
|
+
* - `scope_string`
|
|
2557
|
+
* - `flow_owner`
|
|
2558
|
+
* - `flow_administrators`
|
|
2559
|
+
* - `title`
|
|
2560
|
+
* - `created_at`
|
|
2561
|
+
* - `updated_at`
|
|
2562
|
+
*
|
|
2563
|
+
* Supported orderings are:
|
|
2564
|
+
*
|
|
2565
|
+
* - `ASC`
|
|
2566
|
+
* - `DESC`
|
|
2567
|
+
*
|
|
2568
|
+
* @example [
|
|
2569
|
+
* "title ASC",
|
|
2570
|
+
* "id DESC"
|
|
2571
|
+
* ]
|
|
2572
|
+
*/
|
|
2573
|
+
list_flows_orderby: string[];
|
|
2574
|
+
/**
|
|
2575
|
+
* @description Ordering criteria to apply to the list of runs.
|
|
2576
|
+
*
|
|
2577
|
+
* This field is a comma-separated list of sort criteria,
|
|
2578
|
+
* and follows this syntax:
|
|
2579
|
+
*
|
|
2580
|
+
* ```
|
|
2581
|
+
* CRITERION1[,CRITERION2[,...]]
|
|
2582
|
+
* ```
|
|
2583
|
+
*
|
|
2584
|
+
* and each individual `CRITERION` follows this syntax:
|
|
2585
|
+
*
|
|
2586
|
+
* ```
|
|
2587
|
+
* FIELD ORDERING
|
|
2588
|
+
* ```
|
|
2589
|
+
*
|
|
2590
|
+
* The first value, `FIELD`, indicates the field to sort by;
|
|
2591
|
+
* the second value, `ORDERING`, indicates the sorting order.
|
|
2592
|
+
*
|
|
2593
|
+
* When additional comma-separated criteria are added,
|
|
2594
|
+
* the first criterion will be used to sort the data;
|
|
2595
|
+
* subsequent criteria will be applied for ties.
|
|
2596
|
+
*
|
|
2597
|
+
* Supported fields are:
|
|
2598
|
+
*
|
|
2599
|
+
* - `id`
|
|
2600
|
+
* - `start_time`
|
|
2601
|
+
* - `completion_time`
|
|
2602
|
+
* - `status`
|
|
2603
|
+
* - `label`
|
|
2604
|
+
*
|
|
2605
|
+
* Supported orderings are:
|
|
2606
|
+
*
|
|
2607
|
+
* - `ASC`
|
|
2608
|
+
* - `DESC`
|
|
2609
|
+
*
|
|
2610
|
+
* @example [
|
|
2611
|
+
* "start_time ASC",
|
|
2612
|
+
* "id DESC"
|
|
2613
|
+
* ]
|
|
2614
|
+
*/
|
|
2615
|
+
list_runs_orderby: string[];
|
|
2616
|
+
};
|
|
2617
|
+
requestBodies: never;
|
|
2618
|
+
headers: never;
|
|
2619
|
+
pathItems: never;
|
|
2620
|
+
}
|
|
2621
|
+
export type $defs = Record<string, never>;
|
|
2622
|
+
export type operations = Record<string, never>;
|
|
2623
|
+
//# sourceMappingURL=flows.d.ts.map
|