Globus SDK for JavaScript
    Preparing search index...

    Interface components

    interface components {
        headers: never;
        parameters: {
            filter_completion_time: string;
            filter_start_time: string;
            flow_id: string;
            list_flows_orderby: string[];
            list_registered_apis_orderby: string[];
            list_runs_orderby: string[];
            list_web_inputs_orderby: string[];
            run_id: string;
        };
        pathItems: never;
        requestBodies: never;
        responses: {
            HTTP202Response: {
                content: { "application/json": Record<string, unknown> };
                headers: { [name: string]: unknown };
            };
            HTTP403Response: {
                content: {
                    "application/json": { error: { code: string; detail: string } };
                };
                headers: { [name: string]: unknown };
            };
            HTTP422Response: {
                content: {
                    "application/json": {
                        error: {
                            code: string;
                            detail: { loc: string[]; msg: string; type: string }[];
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
        schemas: {
            _WebInputClosedTimestamp: string
            | null;
            _WebInputContext: {
                presentation_style?: string;
                rows?: { field: string; value: string }[];
                title?: string;
            };
            _WebInputCreatedTimestamp: string;
            _WebInputCreatorUrn: string;
            _WebInputEditedTimestamp: string;
            _WebInputFlowInfo: { id: string; title: string };
            _WebInputId: string;
            _WebInputInputSchema: Record<string, unknown>;
            _WebInputInputType: "selection";
            _WebInputOptions: {
                description: string;
                label: string;
                option_id: string;
            }[];
            _WebInputRoles: { respondent_urns: string[]; viewer_urns: string[] };
            _WebInputRunInfo: { id: string; label: string | null };
            _WebInputStatus: "closed" | "open";
            _WebInputTitle: string;
            _WebInputUserRoles: ("viewer" | "respondent")[];
            Action: {
                ActionScope?: string;
                ActionUrl: string;
                Catch?: unknown;
                Comment?: unknown;
                End?: unknown;
                ExceptionOnActionFailure: boolean;
                InputPath?: unknown;
                Next?: unknown;
                Parameters?: unknown;
                ResultPath?: unknown;
                RunAs?: string;
                Type: string;
                WaitTime?: number;
            } & { End?: boolean; Next?: string } & {
                Parameters?: { [key: string]: unknown };
            } & { InputPath?: string } & { ResultPath?: string } & {
                Catch?: (
                    { ErrorEquals: string[]; Next: string; ResultPath?: unknown } & {
                        ResultPath?: string;
                    }
                )[];
            };
            ActivityNotificationPolicy: {
                status: ("SUCCEEDED" | "FAILED" | "INACTIVE")[];
            };
            BatchRunUpdateOperation: {
                run_managers?: string[];
                run_monitors?: string[];
                tags?: string[];
            };
            BatchRunUpdateSetOperation: {
                run_managers?: string[];
                run_monitors?: string[];
                status?: "cancel";
                tags?: string[];
            };
            Catch: {
                Catch?: (
                    { ErrorEquals: string[]; Next: string; ResultPath?: unknown } & {
                        ResultPath?: string;
                    }
                )[];
            };
            Choice: {
                Choices: (
                    { Next?: string } & {
                        And?: (
                            { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
                        )[];
                        BooleanEquals?: boolean;
                        BooleanEqualsPath?: string;
                        IsBoolean?: boolean;
                        IsNull?: boolean;
                        IsNumeric?: boolean;
                        IsPresent?: boolean;
                        IsString?: boolean;
                        IsTimestamp?: boolean;
                        Not?: { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; };
                        NumericEquals?: number;
                        NumericEqualsPath?: string;
                        NumericGreaterThan?: number;
                        NumericGreaterThanEquals?: number;
                        NumericGreaterThanEqualsPath?: string;
                        NumericGreaterThanPath?: string;
                        NumericLessThan?: number;
                        NumericLessThanEquals?: number;
                        NumericLessThanEqualsPath?: string;
                        NumericLessThanPath?: string;
                        Or?: (
                            { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
                        )[];
                        StringEquals?: string;
                        StringEqualsPath?: string;
                        StringGreaterThan?: string;
                        StringGreaterThanEquals?: string;
                        StringGreaterThanEqualsPath?: string;
                        StringGreaterThanPath?: string;
                        StringLessThan?: string;
                        StringLessThanEquals?: string;
                        StringLessThanEqualsPath?: string;
                        StringLessThanPath?: string;
                        StringMatches?: string;
                        TimestampEquals?: string;
                        TimestampEqualsPath?: string;
                        TimestampGreaterThan?: string;
                        TimestampGreaterThanEquals?: string;
                        TimestampGreaterThanEqualsPath?: string;
                        TimestampGreaterThanPath?: string;
                        TimestampLessThan?: string;
                        TimestampLessThanEquals?: string;
                        TimestampLessThanEqualsPath?: string;
                        TimestampLessThanPath?: string;
                        Variable?: string;
                    }
                )[];
                Comment?: string;
                Default?: string;
                Type?: string;
            };
            ChoiceRule: {
                And?: (
                    { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
                )[];
                BooleanEquals?: boolean;
                BooleanEqualsPath?: string;
                IsBoolean?: boolean;
                IsNull?: boolean;
                IsNumeric?: boolean;
                IsPresent?: boolean;
                IsString?: boolean;
                IsTimestamp?: boolean;
                Not?: { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; };
                NumericEquals?: number;
                NumericEqualsPath?: string;
                NumericGreaterThan?: number;
                NumericGreaterThanEquals?: number;
                NumericGreaterThanEqualsPath?: string;
                NumericGreaterThanPath?: string;
                NumericLessThan?: number;
                NumericLessThanEquals?: number;
                NumericLessThanEqualsPath?: string;
                NumericLessThanPath?: string;
                Or?: (
                    { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
                )[];
                StringEquals?: string;
                StringEqualsPath?: string;
                StringGreaterThan?: string;
                StringGreaterThanEquals?: string;
                StringGreaterThanEqualsPath?: string;
                StringGreaterThanPath?: string;
                StringLessThan?: string;
                StringLessThanEquals?: string;
                StringLessThanEqualsPath?: string;
                StringLessThanPath?: string;
                StringMatches?: string;
                TimestampEquals?: string;
                TimestampEqualsPath?: string;
                TimestampGreaterThan?: string;
                TimestampGreaterThanEquals?: string;
                TimestampGreaterThanEqualsPath?: string;
                TimestampGreaterThanPath?: string;
                TimestampLessThan?: string;
                TimestampLessThanEquals?: string;
                TimestampLessThanEqualsPath?: string;
                TimestampLessThanPath?: string;
                Variable?: string;
            };
            ExpressionEval: {
                Comment?: unknown;
                Next: string;
                Parameters: unknown;
                ResultPath: unknown;
                Type?: string;
            } & { Parameters?: { [key: string]: unknown } } & { ResultPath?: string };
            Fail: { Cause?: string; Comment?: string; Error?: string; Type?: string };
            FlowDefinition: {
                Comment?: string;
                StartAt: string;
                States: {
                    [key: string]:
                        | {
                            Comment?: unknown;
                            End?: unknown;
                            InputPath?: unknown;
                            Next?: unknown;
                            Parameters?: unknown;
                            ResultPath?: unknown;
                            Type?: string;
                        } & { End?: boolean; Next?: string } & {
                            Parameters?: { [key: string]: unknown };
                        } & { InputPath?: string } & { ResultPath?: string }
                        | {
                            ActionScope?: string;
                            ActionUrl: string;
                            Catch?: unknown;
                            Comment?: unknown;
                            End?: unknown;
                            ExceptionOnActionFailure: boolean;
                            InputPath?: unknown;
                            Next?: unknown;
                            Parameters?: unknown;
                            ResultPath?: unknown;
                            RunAs?: string;
                            Type: string;
                            WaitTime?: number;
                        } & { End?: boolean; Next?: string } & {
                            Parameters?: { [key: string]: unknown };
                        } & { InputPath?: string } & { ResultPath?: string } & {
                            Catch?: (
                                { ErrorEquals: (...)[]; Next: string; ResultPath?: unknown } & {
                                    ResultPath?: (...) | (...);
                                }
                            )[];
                        }
                        | {
                            Comment?: unknown;
                            Next?: string;
                            Seconds?: number;
                            SecondsPath?: string;
                            Timestamp?: string;
                            TimestampPath?: string;
                            Type?: string;
                        }
                        | {
                            Choices: (
                                { Next?: string } & {
                                    And?: (
                                        { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
                                    )[];
                                    BooleanEquals?: boolean;
                                    BooleanEqualsPath?: string;
                                    IsBoolean?: boolean;
                                    IsNull?: boolean;
                                    IsNumeric?: boolean;
                                    IsPresent?: boolean;
                                    IsString?: boolean;
                                    IsTimestamp?: boolean;
                                    Not?: { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; };
                                    NumericEquals?: number;
                                    NumericEqualsPath?: string;
                                    NumericGreaterThan?: number;
                                    NumericGreaterThanEquals?: number;
                                    NumericGreaterThanEqualsPath?: string;
                                    NumericGreaterThanPath?: string;
                                    NumericLessThan?: number;
                                    NumericLessThanEquals?: number;
                                    NumericLessThanEqualsPath?: string;
                                    NumericLessThanPath?: string;
                                    Or?: (
                                        { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
                                    )[];
                                    StringEquals?: string;
                                    StringEqualsPath?: string;
                                    StringGreaterThan?: string;
                                    StringGreaterThanEquals?: string;
                                    StringGreaterThanEqualsPath?: string;
                                    StringGreaterThanPath?: string;
                                    StringLessThan?: string;
                                    StringLessThanEquals?: string;
                                    StringLessThanEqualsPath?: string;
                                    StringLessThanPath?: string;
                                    StringMatches?: string;
                                    TimestampEquals?: string;
                                    TimestampEqualsPath?: string;
                                    TimestampGreaterThan?: string;
                                    TimestampGreaterThanEquals?: string;
                                    TimestampGreaterThanEqualsPath?: string;
                                    TimestampGreaterThanPath?: string;
                                    TimestampLessThan?: string;
                                    TimestampLessThanEquals?: string;
                                    TimestampLessThanEqualsPath?: string;
                                    TimestampLessThanPath?: string;
                                    Variable?: string;
                                }
                            )[];
                            Comment?: string;
                            Default?: string;
                            Type?: string;
                        }
                        | {
                            Comment?: unknown;
                            Next: string;
                            Parameters: unknown;
                            ResultPath: unknown;
                            Type?: string;
                        } & { Parameters?: { [key: string]: unknown } } & {
                            ResultPath?: string;
                        }
                        | { Cause?: string; Comment?: string; Error?: string; Type?: string };
                };
            };
            FlowEmbed: {
                created_at: string;
                deleted_at?: string;
                description?: string;
                flow_owner?: string;
                id: string;
                keywords?: string[];
                subtitle?: string;
                title: string;
                updated_at?: string;
            };
            FlowResponse: {
                api_version?: "1.0";
                created_at?: string;
                definition?: {
                    Comment?: string;
                    StartAt: string;
                    States: {
                        [key: string]: | {
                            Comment?: unknown;
                            End?: unknown;
                            InputPath?: unknown;
                            Next?: unknown;
                            Parameters?: unknown;
                            ResultPath?: unknown;
                            Type?: string;
                        } & { End?: boolean; Next?: string } & {
                            Parameters?: { [key: string]: unknown };
                        } & { InputPath?: string } & { ResultPath?: string }
                        | {
                            ActionScope?: string;
                            ActionUrl: string;
                            Catch?: unknown;
                            Comment?: unknown;
                            End?: unknown;
                            ExceptionOnActionFailure: boolean;
                            InputPath?: unknown;
                            Next?: unknown;
                            Parameters?: unknown;
                            ResultPath?: unknown;
                            RunAs?: string;
                            Type: string;
                            WaitTime?: number;
                        } & { End?: boolean; Next?: string } & {
                            Parameters?: { [key: string]: unknown };
                        } & { InputPath?: string } & { ResultPath?: string } & {
                            Catch?: ((...) & (...))[];
                        }
                        | {
                            Comment?: unknown;
                            Next?: string;
                            Seconds?: number;
                            SecondsPath?: string;
                            Timestamp?: string;
                            TimestampPath?: string;
                            Type?: string;
                        }
                        | {
                            Choices: (
                                { Next?: (...)
                                | (...) } & {
                                    And?: (...) | (...);
                                    BooleanEquals?: (...) | (...) | (...);
                                    BooleanEqualsPath?: (...) | (...);
                                    IsBoolean?: (...) | (...) | (...);
                                    IsNull?: (...) | (...) | (...);
                                    IsNumeric?: (...) | (...) | (...);
                                    IsPresent?: (...) | (...) | (...);
                                    IsString?: (...) | (...) | (...);
                                    IsTimestamp?: (...) | (...) | (...);
                                    Not?: (...) | (...);
                                    NumericEquals?: (...) | (...);
                                    NumericEqualsPath?: (...) | (...);
                                    NumericGreaterThan?: (...) | (...);
                                    NumericGreaterThanEquals?: (...) | (...);
                                    NumericGreaterThanEqualsPath?: (...) | (...);
                                    NumericGreaterThanPath?: (...) | (...);
                                    NumericLessThan?: (...) | (...);
                                    NumericLessThanEquals?: (...) | (...);
                                    NumericLessThanEqualsPath?: (...) | (...);
                                    NumericLessThanPath?: (...) | (...);
                                    Or?: (...) | (...);
                                    StringEquals?: (...) | (...);
                                    StringEqualsPath?: (...) | (...);
                                    StringGreaterThan?: (...) | (...);
                                    StringGreaterThanEquals?: (...) | (...);
                                    StringGreaterThanEqualsPath?: (...) | (...);
                                    StringGreaterThanPath?: (...) | (...);
                                    StringLessThan?: (...) | (...);
                                    StringLessThanEquals?: (...) | (...);
                                    StringLessThanEqualsPath?: (...) | (...);
                                    StringLessThanPath?: (...) | (...);
                                    StringMatches?: (...) | (...);
                                    TimestampEquals?: (...) | (...);
                                    TimestampEqualsPath?: (...) | (...);
                                    TimestampGreaterThan?: (...) | (...);
                                    TimestampGreaterThanEquals?: (...) | (...);
                                    TimestampGreaterThanEqualsPath?: (...) | (...);
                                    TimestampGreaterThanPath?: (...) | (...);
                                    TimestampLessThan?: (...) | (...);
                                    TimestampLessThanEquals?: (...) | (...);
                                    TimestampLessThanEqualsPath?: (...) | (...);
                                    TimestampLessThanPath?: (...) | (...);
                                    Variable?: (...) | (...);
                                }
                            )[];
                            Comment?: string;
                            Default?: string;
                            Type?: string;
                        }
                        | {
                            Comment?: unknown;
                            Next: string;
                            Parameters: unknown;
                            ResultPath: unknown;
                            Type?: string;
                        } & { Parameters?: { [key: string]: unknown } } & {
                            ResultPath?: string;
                        }
                        | { Cause?: string; Comment?: string; Error?: string; Type?: string };
                    };
                };
                description?: string;
                flow_administrators?: string[];
                flow_owner?: string;
                flow_starters?: string[];
                flow_url?: string;
                flow_viewers?: string[];
                globus_auth_scope?: string;
                globus_auth_scopes_by_RunAs?: string[];
                globus_auth_username?: string;
                id?: string;
                input_schema?: Record<string, unknown>
                | null;
                is_high_assurance?: boolean;
                keywords?: string[];
                log_supported?: boolean;
                principal_urn?: string;
                subscription_id?: string;
                subtitle?: string;
                synchronous?: boolean;
                title?: string;
                types?: ("Action" | "Event")[];
                updated_at?: string;
                user_role?:
                    | "flow_owner"
                    | "flow_viewer"
                    | "flow_starter"
                    | "flow_administrator"
                    | "run_manager"
                    | "run_monitor";
                user_roles?: (
                    | "flow_owner"
                    | "flow_viewer"
                    | "flow_starter"
                    | "flow_administrator"
                    | "flow_run_manager"
                    | "flow_run_monitor"
                )[];
            };
            FlowRun: {
                action_id: string;
                blocking_web_input_id: string
                | null;
                completion_time: string;
                details: Record<string, unknown> | null;
                display_status?: string;
                flow_id: string;
                flow_last_updated: string;
                label: string;
                run_id: string;
                run_managers?: string[];
                run_monitors?: string[];
                run_owner: string;
                start_time: string;
                status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED";
                tags: string[];
                user_role:
                    | "run_manager"
                    | "run_monitor"
                    | "run_owner"
                    | "flow_run_manager"
                    | "flow_run_monitor";
                user_roles?: (
                    | "run_manager"
                    | "run_monitor"
                    | "run_owner"
                    | "flow_run_manager"
                    | "flow_run_monitor"
                )[];
            };
            FlowRunWithFlowEmbed: {
                action_id: string;
                blocking_web_input_id: string
                | null;
                completion_time: string;
                details: Record<string, unknown> | null;
                display_status?: string;
                flow_id: string;
                flow_last_updated: string;
                label: string;
                run_id: string;
                run_managers?: string[];
                run_monitors?: string[];
                run_owner: string;
                start_time: string;
                status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED";
                tags: string[];
                user_role:
                    | "run_manager"
                    | "run_monitor"
                    | "run_owner"
                    | "flow_run_manager"
                    | "flow_run_monitor";
                user_roles?: (
                    | "run_manager"
                    | "run_monitor"
                    | "run_owner"
                    | "flow_run_manager"
                    | "flow_run_monitor"
                )[];
            } & {
                flow_description?: {
                    created_at: string;
                    deleted_at?: string;
                    description?: string;
                    flow_owner?: string;
                    id: string;
                    keywords?: string[];
                    subtitle?: string;
                    title: string;
                    updated_at?: string;
                };
            };
            FlowScopes: { [key: string]: string[] };
            FlowValidationErrorResponse: {
                debug_id: string;
                error: {
                    code: string;
                    detail: string | { loc: string[]; msg: string; type: string }[];
                    message?: string;
                };
            };
            FlowValidationResponse: { scopes?: { [key: string]: string[] } };
            GetRunDefinitionResponse: {
                definition: Record<string, unknown>;
                flow_id: string;
                input_schema: Record<string, unknown>;
            };
            InputBody: { [key: string]: unknown };
            InputPath: { InputPath?: string };
            JsonPathPattern: string;
            Label: string;
            LocationErrorList: { loc: string[]; msg: string; type: string }[];
            NextOrEnd: { End?: boolean; Next?: string };
            Parameters: { Parameters?: { [key: string]: unknown } };
            ParametersOrInputPath: { Parameters?: { [key: string]: unknown } } & {
                InputPath?: string;
            };
            ParametersOrInputPathNotRequired: {
                Parameters?: { [key: string]: unknown };
            } & { InputPath?: string };
            Pass: {
                Comment?: unknown;
                End?: unknown;
                InputPath?: unknown;
                Next?: unknown;
                Parameters?: unknown;
                ResultPath?: unknown;
                Type?: string;
            } & { End?: boolean; Next?: string } & {
                Parameters?: { [key: string]: unknown };
            } & { InputPath?: string } & { ResultPath?: string };
            PrincipalURN: string;
            RegisteredApi: {
                created_timestamp: string;
                description: string;
                id: string;
                name: string;
                updated_timestamp: string;
            } & {
                data_templates: {
                    request: { [key: string]: unknown };
                    response: { [key: string]: unknown };
                };
                edited_timestamp?: string
                | null;
                roles: {
                    administrators?: string[];
                    owners?: string[];
                    viewers?: string[];
                };
                scheduled_deletion_timestamp?: string
                | null;
                state_input_schema: { [key: string]: unknown };
                status: "ACTIVE" | "INACTIVE";
                subscription_id: string | null;
                target: {
                    components?: { [key: string]: unknown };
                    destination: {
                        method: "delete" | "get" | "post" | "put" | "patch";
                        url: string;
                    };
                    openapi_version: string;
                    specification: { [key: string]: unknown };
                    type: "openapi";
                };
            };
            RegisteredApiSummary: {
                created_timestamp: string;
                description: string;
                id: string;
                name: string;
                updated_timestamp: string;
            };
            ResultPath: { ResultPath?: string };
            RunManagers: string[];
            RunMonitors: string[];
            RunUpdate: {
                label?: string;
                run_managers?: string[];
                run_monitors?: string[];
                tags?: string[];
            };
            Tags: string[];
            ValidateRun: { message: string };
            Wait: {
                Comment?: unknown;
                Next?: string;
                Seconds?: number;
                SecondsPath?: string;
                Timestamp?: string;
                TimestampPath?: string;
                Type?: string;
            };
            WebInputResponse: {
                closed_timestamp: string
                | null;
                context: {
                    presentation_style?: string;
                    rows?: { field: string; value: string }[];
                    title?: string;
                };
                created_timestamp: string;
                creator_urn: string;
                edited_timestamp: string;
                flow: { id: string; title: string };
                id: string;
                input_schema: Record<string, unknown>;
                input_type: "selection";
                options?: { description: string; label: string; option_id: string }[];
                roles: { respondent_urns: string[]; viewer_urns: string[] };
                run: { id: string; label: string | null };
                status: "closed" | "open";
                user_roles: ("viewer" | "respondent")[];
            };
            WebInputSummary: {
                closed_timestamp: string
                | null;
                created_timestamp: string;
                edited_timestamp: string;
                flow: { id: string; title: string };
                id: string;
                input_type: "selection";
                run: { id: string; label: string | null };
                status: "closed" | "open";
                title: string;
                user_roles: ("viewer" | "respondent")[];
            };
        };
    }
    Index

    Properties

    headers parameters pathItems requestBodies responses schemas

    Properties

    headers: never
    parameters: {
        filter_completion_time: string;
        filter_start_time: string;
        flow_id: string;
        list_flows_orderby: string[];
        list_registered_apis_orderby: string[];
        list_runs_orderby: string[];
        list_web_inputs_orderby: string[];
        run_id: string;
    }

    Type Declaration

    • filter_completion_time: string

      Given a pair of comma-separated ISO 8601 datetime strings, filter results to only those runs which completed execution within the specified range.

      If one of the dates is omitted, it forms an open range.
For example, if the filter has a datetime followed by a comma (`"DT,"`),
all records with a date greater then or equal to `DT` will be returned.
Similarly, if the filter has a comma followed by a datetime (`",DT"`),
all records with dates less than `DT` will be returned.
If there is no comma, it is treated in the same way as `"DT,"`, above.

Results will contain runs which completed between the first datetime
onwards, up to (but not including) the second datetime.

Note that runs which are still executing will not have a completion time
and will be automatically excluded if this filter is applied.
    • filter_start_time: string

      Given a pair of comma separated ISO 8601 date/time strings, filter results to only those runs which started execution within the specified range.

      If one of the dates is omitted, it forms an open range.
For example, if the filter has a datetime followed by a comma (`"DT,"`),
all records with a date greater then or equal to `DT` will be returned.
Similarly, if the filter has a comma followed by a datetime (`",DT"`),
all records with dates less than `DT` will be returned.
If there is no comma, it is treated in the same way as `"DT,"`, above.

Results will contain runs which began between the first datetime
onwards, up to (but not including) the second datetime.
    • flow_id: string

      The flow ID

    • list_flows_orderby: string[]

      Ordering criteria to apply to the list of flows.

      This field is a comma-separated list of sort criteria,
and follows this syntax:

```
CRITERION1[,CRITERION2[,...]]
```

and each individual `CRITERION` follows this syntax:

```
FIELD ORDERING
```

The first value, `FIELD`, indicates the field to sort by;
the second value, `ORDERING`, indicates the sorting order.

When additional comma-separated criteria are added,
the first criterion will be used to sort the data;
subsequent criteria will be applied for ties.

Supported fields are:

- `id`
- `scope_string`
- `flow_owner`
- `flow_administrators`
- `title`
- `created_at`
- `updated_at`

Supported orderings are:

- `ASC`
- `DESC`
    • list_registered_apis_orderby: string[]

      Ordering criteria to apply to the list of Registered APIs.

      This field is a comma-separated list of sort criteria,
and follows this syntax:

```
CRITERION1[,CRITERION2[,...]]
```

and each individual `CRITERION` follows this syntax:

```
FIELD ORDERING
```

The first value, `FIELD`, indicates the field to sort by;
the second value, `ORDERING`, indicates the sorting order.

When additional comma-separated criteria are added,
the first criterion will be used to sort the data;
subsequent criteria will be applied for ties.

Supported fields are:

- `id`
- `name`
- `created_timestamp`
- `updated_timestamp`

Supported orderings are:

- `ASC`
- `DESC`
    • list_runs_orderby: string[]

      Ordering criteria to apply to the list of runs.

      This field is a comma-separated list of sort criteria,
and follows this syntax:

```
CRITERION1[,CRITERION2[,...]]
```

and each individual `CRITERION` follows this syntax:

```
FIELD ORDERING
```

The first value, `FIELD`, indicates the field to sort by;
the second value, `ORDERING`, indicates the sorting order.

When additional comma-separated criteria are added,
the first criterion will be used to sort the data;
subsequent criteria will be applied for ties.

Supported fields are:

- `id`
- `start_time`
- `completion_time`
- `status`
- `label`

Supported orderings are:

- `ASC`
- `DESC`
    • list_web_inputs_orderby: string[]

      Ordering criteria to apply to the list of Web Inputs.

      This field is a comma-separated list of sort criteria,
and follows this syntax:

```
CRITERION1[,CRITERION2[,...]]
```

and each individual `CRITERION` follows this syntax:

```
FIELD ORDERING
```

The first value, `FIELD`, indicates the field to sort by;
the second value, `ORDERING`, indicates the sorting order.

When additional comma-separated criteria are added,
the first criterion will be used to sort the data;
subsequent criteria will be applied for ties.

Supported fields are:

- `created_timestamp`
- `edited_timestamp`
- `closed_timestamp`

Supported orderings are:

- `ASC`
- `DESC`
    • run_id: string

      The run ID

    pathItems: never
    requestBodies: never
    responses: {
        HTTP202Response: {
            content: { "application/json": Record<string, unknown> };
            headers: { [name: string]: unknown };
        };
        HTTP403Response: {
            content: {
                "application/json": { error: { code: string; detail: string } };
            };
            headers: { [name: string]: unknown };
        };
        HTTP422Response: {
            content: {
                "application/json": {
                    error: {
                        code: string;
                        detail: { loc: string[]; msg: string; type: string }[];
                    };
                };
            };
            headers: { [name: string]: unknown };
        };
    }

    Type Declaration

    • HTTP202Response: {
          content: { "application/json": Record<string, unknown> };
          headers: { [name: string]: unknown };
      }

      The requested operation was accepted.

      The operation may have been completed, or may be completed at a later time.
A follow-up API request may be needed to confirm the status of the operation.
    • HTTP403Response: {
          content: {
              "application/json": { error: { code: string; detail: string } };
          };
          headers: { [name: string]: unknown };
      }

      The requesting user is not authorized to make the requested changes.

    • HTTP422Response: {
          content: {
              "application/json": {
                  error: {
                      code: string;
                      detail: { loc: string[]; msg: string; type: string }[];
                  };
              };
          };
          headers: { [name: string]: unknown };
      }

      The input document failed input validation in some way.

    schemas: {
        _WebInputClosedTimestamp: string | null;
        _WebInputContext: {
            presentation_style?: string;
            rows?: { field: string; value: string }[];
            title?: string;
        };
        _WebInputCreatedTimestamp: string;
        _WebInputCreatorUrn: string;
        _WebInputEditedTimestamp: string;
        _WebInputFlowInfo: { id: string; title: string };
        _WebInputId: string;
        _WebInputInputSchema: Record<string, unknown>;
        _WebInputInputType: "selection";
        _WebInputOptions: { description: string; label: string; option_id: string }[];
        _WebInputRoles: { respondent_urns: string[]; viewer_urns: string[] };
        _WebInputRunInfo: { id: string; label: string | null };
        _WebInputStatus: "closed" | "open";
        _WebInputTitle: string;
        _WebInputUserRoles: ("viewer" | "respondent")[];
        Action: {
            ActionScope?: string;
            ActionUrl: string;
            Catch?: unknown;
            Comment?: unknown;
            End?: unknown;
            ExceptionOnActionFailure: boolean;
            InputPath?: unknown;
            Next?: unknown;
            Parameters?: unknown;
            ResultPath?: unknown;
            RunAs?: string;
            Type: string;
            WaitTime?: number;
        } & { End?: boolean; Next?: string } & {
            Parameters?: { [key: string]: unknown };
        } & { InputPath?: string } & { ResultPath?: string } & {
            Catch?: (
                { ErrorEquals: string[]; Next: string; ResultPath?: unknown } & {
                    ResultPath?: string;
                }
            )[];
        };
        ActivityNotificationPolicy: {
            status: ("SUCCEEDED" | "FAILED" | "INACTIVE")[];
        };
        BatchRunUpdateOperation: {
            run_managers?: string[];
            run_monitors?: string[];
            tags?: string[];
        };
        BatchRunUpdateSetOperation: {
            run_managers?: string[];
            run_monitors?: string[];
            status?: "cancel";
            tags?: string[];
        };
        Catch: {
            Catch?: (
                { ErrorEquals: string[]; Next: string; ResultPath?: unknown } & {
                    ResultPath?: string;
                }
            )[];
        };
        Choice: {
            Choices: (
                { Next?: string } & {
                    And?: (
                        { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
                    )[];
                    BooleanEquals?: boolean;
                    BooleanEqualsPath?: string;
                    IsBoolean?: boolean;
                    IsNull?: boolean;
                    IsNumeric?: boolean;
                    IsPresent?: boolean;
                    IsString?: boolean;
                    IsTimestamp?: boolean;
                    Not?: { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; };
                    NumericEquals?: number;
                    NumericEqualsPath?: string;
                    NumericGreaterThan?: number;
                    NumericGreaterThanEquals?: number;
                    NumericGreaterThanEqualsPath?: string;
                    NumericGreaterThanPath?: string;
                    NumericLessThan?: number;
                    NumericLessThanEquals?: number;
                    NumericLessThanEqualsPath?: string;
                    NumericLessThanPath?: string;
                    Or?: (
                        { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
                    )[];
                    StringEquals?: string;
                    StringEqualsPath?: string;
                    StringGreaterThan?: string;
                    StringGreaterThanEquals?: string;
                    StringGreaterThanEqualsPath?: string;
                    StringGreaterThanPath?: string;
                    StringLessThan?: string;
                    StringLessThanEquals?: string;
                    StringLessThanEqualsPath?: string;
                    StringLessThanPath?: string;
                    StringMatches?: string;
                    TimestampEquals?: string;
                    TimestampEqualsPath?: string;
                    TimestampGreaterThan?: string;
                    TimestampGreaterThanEquals?: string;
                    TimestampGreaterThanEqualsPath?: string;
                    TimestampGreaterThanPath?: string;
                    TimestampLessThan?: string;
                    TimestampLessThanEquals?: string;
                    TimestampLessThanEqualsPath?: string;
                    TimestampLessThanPath?: string;
                    Variable?: string;
                }
            )[];
            Comment?: string;
            Default?: string;
            Type?: string;
        };
        ChoiceRule: {
            And?: (
                { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
            )[];
            BooleanEquals?: boolean;
            BooleanEqualsPath?: string;
            IsBoolean?: boolean;
            IsNull?: boolean;
            IsNumeric?: boolean;
            IsPresent?: boolean;
            IsString?: boolean;
            IsTimestamp?: boolean;
            Not?: { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; };
            NumericEquals?: number;
            NumericEqualsPath?: string;
            NumericGreaterThan?: number;
            NumericGreaterThanEquals?: number;
            NumericGreaterThanEqualsPath?: string;
            NumericGreaterThanPath?: string;
            NumericLessThan?: number;
            NumericLessThanEquals?: number;
            NumericLessThanEqualsPath?: string;
            NumericLessThanPath?: string;
            Or?: (
                { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
            )[];
            StringEquals?: string;
            StringEqualsPath?: string;
            StringGreaterThan?: string;
            StringGreaterThanEquals?: string;
            StringGreaterThanEqualsPath?: string;
            StringGreaterThanPath?: string;
            StringLessThan?: string;
            StringLessThanEquals?: string;
            StringLessThanEqualsPath?: string;
            StringLessThanPath?: string;
            StringMatches?: string;
            TimestampEquals?: string;
            TimestampEqualsPath?: string;
            TimestampGreaterThan?: string;
            TimestampGreaterThanEquals?: string;
            TimestampGreaterThanEqualsPath?: string;
            TimestampGreaterThanPath?: string;
            TimestampLessThan?: string;
            TimestampLessThanEquals?: string;
            TimestampLessThanEqualsPath?: string;
            TimestampLessThanPath?: string;
            Variable?: string;
        };
        ExpressionEval: {
            Comment?: unknown;
            Next: string;
            Parameters: unknown;
            ResultPath: unknown;
            Type?: string;
        } & { Parameters?: { [key: string]: unknown } } & { ResultPath?: string };
        Fail: { Cause?: string; Comment?: string; Error?: string; Type?: string };
        FlowDefinition: {
            Comment?: string;
            StartAt: string;
            States: {
                [key: string]:
                    | {
                        Comment?: unknown;
                        End?: unknown;
                        InputPath?: unknown;
                        Next?: unknown;
                        Parameters?: unknown;
                        ResultPath?: unknown;
                        Type?: string;
                    } & { End?: boolean; Next?: string } & {
                        Parameters?: { [key: string]: unknown };
                    } & { InputPath?: string } & { ResultPath?: string }
                    | {
                        ActionScope?: string;
                        ActionUrl: string;
                        Catch?: unknown;
                        Comment?: unknown;
                        End?: unknown;
                        ExceptionOnActionFailure: boolean;
                        InputPath?: unknown;
                        Next?: unknown;
                        Parameters?: unknown;
                        ResultPath?: unknown;
                        RunAs?: string;
                        Type: string;
                        WaitTime?: number;
                    } & { End?: boolean; Next?: string } & {
                        Parameters?: { [key: string]: unknown };
                    } & { InputPath?: string } & { ResultPath?: string } & {
                        Catch?: (
                            { ErrorEquals: (...)[]; Next: string; ResultPath?: unknown } & {
                                ResultPath?: (...) | (...);
                            }
                        )[];
                    }
                    | {
                        Comment?: unknown;
                        Next?: string;
                        Seconds?: number;
                        SecondsPath?: string;
                        Timestamp?: string;
                        TimestampPath?: string;
                        Type?: string;
                    }
                    | {
                        Choices: (
                            { Next?: string } & {
                                And?: (
                                    { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
                                )[];
                                BooleanEquals?: boolean;
                                BooleanEqualsPath?: string;
                                IsBoolean?: boolean;
                                IsNull?: boolean;
                                IsNumeric?: boolean;
                                IsPresent?: boolean;
                                IsString?: boolean;
                                IsTimestamp?: boolean;
                                Not?: { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; };
                                NumericEquals?: number;
                                NumericEqualsPath?: string;
                                NumericGreaterThan?: number;
                                NumericGreaterThanEquals?: number;
                                NumericGreaterThanEqualsPath?: string;
                                NumericGreaterThanPath?: string;
                                NumericLessThan?: number;
                                NumericLessThanEquals?: number;
                                NumericLessThanEqualsPath?: string;
                                NumericLessThanPath?: string;
                                Or?: (
                                    { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
                                )[];
                                StringEquals?: string;
                                StringEqualsPath?: string;
                                StringGreaterThan?: string;
                                StringGreaterThanEquals?: string;
                                StringGreaterThanEqualsPath?: string;
                                StringGreaterThanPath?: string;
                                StringLessThan?: string;
                                StringLessThanEquals?: string;
                                StringLessThanEqualsPath?: string;
                                StringLessThanPath?: string;
                                StringMatches?: string;
                                TimestampEquals?: string;
                                TimestampEqualsPath?: string;
                                TimestampGreaterThan?: string;
                                TimestampGreaterThanEquals?: string;
                                TimestampGreaterThanEqualsPath?: string;
                                TimestampGreaterThanPath?: string;
                                TimestampLessThan?: string;
                                TimestampLessThanEquals?: string;
                                TimestampLessThanEqualsPath?: string;
                                TimestampLessThanPath?: string;
                                Variable?: string;
                            }
                        )[];
                        Comment?: string;
                        Default?: string;
                        Type?: string;
                    }
                    | {
                        Comment?: unknown;
                        Next: string;
                        Parameters: unknown;
                        ResultPath: unknown;
                        Type?: string;
                    } & { Parameters?: { [key: string]: unknown } } & {
                        ResultPath?: string;
                    }
                    | { Cause?: string; Comment?: string; Error?: string; Type?: string };
            };
        };
        FlowEmbed: {
            created_at: string;
            deleted_at?: string;
            description?: string;
            flow_owner?: string;
            id: string;
            keywords?: string[];
            subtitle?: string;
            title: string;
            updated_at?: string;
        };
        FlowResponse: {
            api_version?: "1.0";
            created_at?: string;
            definition?: {
                Comment?: string;
                StartAt: string;
                States: {
                    [key: string]: | {
                        Comment?: unknown;
                        End?: unknown;
                        InputPath?: unknown;
                        Next?: unknown;
                        Parameters?: unknown;
                        ResultPath?: unknown;
                        Type?: string;
                    } & { End?: boolean; Next?: string } & {
                        Parameters?: { [key: string]: unknown };
                    } & { InputPath?: string } & { ResultPath?: string }
                    | {
                        ActionScope?: string;
                        ActionUrl: string;
                        Catch?: unknown;
                        Comment?: unknown;
                        End?: unknown;
                        ExceptionOnActionFailure: boolean;
                        InputPath?: unknown;
                        Next?: unknown;
                        Parameters?: unknown;
                        ResultPath?: unknown;
                        RunAs?: string;
                        Type: string;
                        WaitTime?: number;
                    } & { End?: boolean; Next?: string } & {
                        Parameters?: { [key: string]: unknown };
                    } & { InputPath?: string } & { ResultPath?: string } & {
                        Catch?: ((...) & (...))[];
                    }
                    | {
                        Comment?: unknown;
                        Next?: string;
                        Seconds?: number;
                        SecondsPath?: string;
                        Timestamp?: string;
                        TimestampPath?: string;
                        Type?: string;
                    }
                    | {
                        Choices: (
                            { Next?: (...)
                            | (...) } & {
                                And?: (...) | (...);
                                BooleanEquals?: (...) | (...) | (...);
                                BooleanEqualsPath?: (...) | (...);
                                IsBoolean?: (...) | (...) | (...);
                                IsNull?: (...) | (...) | (...);
                                IsNumeric?: (...) | (...) | (...);
                                IsPresent?: (...) | (...) | (...);
                                IsString?: (...) | (...) | (...);
                                IsTimestamp?: (...) | (...) | (...);
                                Not?: (...) | (...);
                                NumericEquals?: (...) | (...);
                                NumericEqualsPath?: (...) | (...);
                                NumericGreaterThan?: (...) | (...);
                                NumericGreaterThanEquals?: (...) | (...);
                                NumericGreaterThanEqualsPath?: (...) | (...);
                                NumericGreaterThanPath?: (...) | (...);
                                NumericLessThan?: (...) | (...);
                                NumericLessThanEquals?: (...) | (...);
                                NumericLessThanEqualsPath?: (...) | (...);
                                NumericLessThanPath?: (...) | (...);
                                Or?: (...) | (...);
                                StringEquals?: (...) | (...);
                                StringEqualsPath?: (...) | (...);
                                StringGreaterThan?: (...) | (...);
                                StringGreaterThanEquals?: (...) | (...);
                                StringGreaterThanEqualsPath?: (...) | (...);
                                StringGreaterThanPath?: (...) | (...);
                                StringLessThan?: (...) | (...);
                                StringLessThanEquals?: (...) | (...);
                                StringLessThanEqualsPath?: (...) | (...);
                                StringLessThanPath?: (...) | (...);
                                StringMatches?: (...) | (...);
                                TimestampEquals?: (...) | (...);
                                TimestampEqualsPath?: (...) | (...);
                                TimestampGreaterThan?: (...) | (...);
                                TimestampGreaterThanEquals?: (...) | (...);
                                TimestampGreaterThanEqualsPath?: (...) | (...);
                                TimestampGreaterThanPath?: (...) | (...);
                                TimestampLessThan?: (...) | (...);
                                TimestampLessThanEquals?: (...) | (...);
                                TimestampLessThanEqualsPath?: (...) | (...);
                                TimestampLessThanPath?: (...) | (...);
                                Variable?: (...) | (...);
                            }
                        )[];
                        Comment?: string;
                        Default?: string;
                        Type?: string;
                    }
                    | {
                        Comment?: unknown;
                        Next: string;
                        Parameters: unknown;
                        ResultPath: unknown;
                        Type?: string;
                    } & { Parameters?: { [key: string]: unknown } } & {
                        ResultPath?: string;
                    }
                    | { Cause?: string; Comment?: string; Error?: string; Type?: string };
                };
            };
            description?: string;
            flow_administrators?: string[];
            flow_owner?: string;
            flow_starters?: string[];
            flow_url?: string;
            flow_viewers?: string[];
            globus_auth_scope?: string;
            globus_auth_scopes_by_RunAs?: string[];
            globus_auth_username?: string;
            id?: string;
            input_schema?: Record<string, unknown>
            | null;
            is_high_assurance?: boolean;
            keywords?: string[];
            log_supported?: boolean;
            principal_urn?: string;
            subscription_id?: string;
            subtitle?: string;
            synchronous?: boolean;
            title?: string;
            types?: ("Action" | "Event")[];
            updated_at?: string;
            user_role?:
                | "flow_owner"
                | "flow_viewer"
                | "flow_starter"
                | "flow_administrator"
                | "run_manager"
                | "run_monitor";
            user_roles?: (
                | "flow_owner"
                | "flow_viewer"
                | "flow_starter"
                | "flow_administrator"
                | "flow_run_manager"
                | "flow_run_monitor"
            )[];
        };
        FlowRun: {
            action_id: string;
            blocking_web_input_id: string
            | null;
            completion_time: string;
            details: Record<string, unknown> | null;
            display_status?: string;
            flow_id: string;
            flow_last_updated: string;
            label: string;
            run_id: string;
            run_managers?: string[];
            run_monitors?: string[];
            run_owner: string;
            start_time: string;
            status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED";
            tags: string[];
            user_role:
                | "run_manager"
                | "run_monitor"
                | "run_owner"
                | "flow_run_manager"
                | "flow_run_monitor";
            user_roles?: (
                | "run_manager"
                | "run_monitor"
                | "run_owner"
                | "flow_run_manager"
                | "flow_run_monitor"
            )[];
        };
        FlowRunWithFlowEmbed: {
            action_id: string;
            blocking_web_input_id: string
            | null;
            completion_time: string;
            details: Record<string, unknown> | null;
            display_status?: string;
            flow_id: string;
            flow_last_updated: string;
            label: string;
            run_id: string;
            run_managers?: string[];
            run_monitors?: string[];
            run_owner: string;
            start_time: string;
            status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED";
            tags: string[];
            user_role:
                | "run_manager"
                | "run_monitor"
                | "run_owner"
                | "flow_run_manager"
                | "flow_run_monitor";
            user_roles?: (
                | "run_manager"
                | "run_monitor"
                | "run_owner"
                | "flow_run_manager"
                | "flow_run_monitor"
            )[];
        } & {
            flow_description?: {
                created_at: string;
                deleted_at?: string;
                description?: string;
                flow_owner?: string;
                id: string;
                keywords?: string[];
                subtitle?: string;
                title: string;
                updated_at?: string;
            };
        };
        FlowScopes: { [key: string]: string[] };
        FlowValidationErrorResponse: {
            debug_id: string;
            error: {
                code: string;
                detail: string | { loc: string[]; msg: string; type: string }[];
                message?: string;
            };
        };
        FlowValidationResponse: { scopes?: { [key: string]: string[] } };
        GetRunDefinitionResponse: {
            definition: Record<string, unknown>;
            flow_id: string;
            input_schema: Record<string, unknown>;
        };
        InputBody: { [key: string]: unknown };
        InputPath: { InputPath?: string };
        JsonPathPattern: string;
        Label: string;
        LocationErrorList: { loc: string[]; msg: string; type: string }[];
        NextOrEnd: { End?: boolean; Next?: string };
        Parameters: { Parameters?: { [key: string]: unknown } };
        ParametersOrInputPath: { Parameters?: { [key: string]: unknown } } & {
            InputPath?: string;
        };
        ParametersOrInputPathNotRequired: {
            Parameters?: { [key: string]: unknown };
        } & { InputPath?: string };
        Pass: {
            Comment?: unknown;
            End?: unknown;
            InputPath?: unknown;
            Next?: unknown;
            Parameters?: unknown;
            ResultPath?: unknown;
            Type?: string;
        } & { End?: boolean; Next?: string } & {
            Parameters?: { [key: string]: unknown };
        } & { InputPath?: string } & { ResultPath?: string };
        PrincipalURN: string;
        RegisteredApi: {
            created_timestamp: string;
            description: string;
            id: string;
            name: string;
            updated_timestamp: string;
        } & {
            data_templates: {
                request: { [key: string]: unknown };
                response: { [key: string]: unknown };
            };
            edited_timestamp?: string
            | null;
            roles: {
                administrators?: string[];
                owners?: string[];
                viewers?: string[];
            };
            scheduled_deletion_timestamp?: string
            | null;
            state_input_schema: { [key: string]: unknown };
            status: "ACTIVE" | "INACTIVE";
            subscription_id: string | null;
            target: {
                components?: { [key: string]: unknown };
                destination: {
                    method: "delete" | "get" | "post" | "put" | "patch";
                    url: string;
                };
                openapi_version: string;
                specification: { [key: string]: unknown };
                type: "openapi";
            };
        };
        RegisteredApiSummary: {
            created_timestamp: string;
            description: string;
            id: string;
            name: string;
            updated_timestamp: string;
        };
        ResultPath: { ResultPath?: string };
        RunManagers: string[];
        RunMonitors: string[];
        RunUpdate: {
            label?: string;
            run_managers?: string[];
            run_monitors?: string[];
            tags?: string[];
        };
        Tags: string[];
        ValidateRun: { message: string };
        Wait: {
            Comment?: unknown;
            Next?: string;
            Seconds?: number;
            SecondsPath?: string;
            Timestamp?: string;
            TimestampPath?: string;
            Type?: string;
        };
        WebInputResponse: {
            closed_timestamp: string
            | null;
            context: {
                presentation_style?: string;
                rows?: { field: string; value: string }[];
                title?: string;
            };
            created_timestamp: string;
            creator_urn: string;
            edited_timestamp: string;
            flow: { id: string; title: string };
            id: string;
            input_schema: Record<string, unknown>;
            input_type: "selection";
            options?: { description: string; label: string; option_id: string }[];
            roles: { respondent_urns: string[]; viewer_urns: string[] };
            run: { id: string; label: string | null };
            status: "closed" | "open";
            user_roles: ("viewer" | "respondent")[];
        };
        WebInputSummary: {
            closed_timestamp: string
            | null;
            created_timestamp: string;
            edited_timestamp: string;
            flow: { id: string; title: string };
            id: string;
            input_type: "selection";
            run: { id: string; label: string | null };
            status: "closed" | "open";
            title: string;
            user_roles: ("viewer" | "respondent")[];
        };
    }

    Type Declaration

    • _WebInputClosedTimestamp: string | null

      Format: date-time

      A timezone-aware ISO8601 format string that represents the time at which the Web Input was closed. Null if the Web Input is still open.

    • _WebInputContext: {
          presentation_style?: string;
          rows?: { field: string; value: string }[];
          title?: string;
      }

      Information that helps respondents understand what they're responding to. For example, "What file transfer am I approving or denying?"

      • Optionalpresentation_style?: string

        The suggested way by which the rows should be rendered for display.

      • Optionalrows?: { field: string; value: string }[]
      • Optionaltitle?: string

        A title for the Web Input. This may be displayed as an human-readable label for the Web Input itself, or it may be used as a bold header on a webpage displaying the Web Input as a form.

    • _WebInputCreatedTimestamp: string

      Format: date-time

      A timezone-aware ISO8601 format string that represents the time at which the Web Input was created.

    • _WebInputCreatorUrn: string

      The Globus Auth identity that created the Web Input. Creators are not implicitly granted "view" access to the Web Input.

    • _WebInputEditedTimestamp: string

      Format: date-time

      A timezone-aware ISO8601 format string that represents the time at which the Web Input was last edited.

    • _WebInputFlowInfo: { id: string; title: string }

      Info about the Flow associated with the Web Input.

      • id: string

        Format: uuid

        The unique identifier for the associated Flow.

      • title: string

        The title of the associated Flow.

    • _WebInputId: string

      Format: uuid

      The unique identifier for the Web Input.

    • _WebInputInputSchema: Record<string, unknown>

      The input schema used to validate all responses to the Web Input.

    • _WebInputInputType: "selection"

      The type of Web Input.

    • _WebInputOptions: { description: string; label: string; option_id: string }[]

      The individual options associated with Web Input. This field is only present when the input type is "selection".

    • _WebInputRoles: { respondent_urns: string[]; viewer_urns: string[] }

      The Globus Auth identities and groups that have been assigned roles/permissions to the Web Input.

      • respondent_urns: string[]

        Identities and groups that are allowed to submit responses to the Web Input. Respondents are also allowed to view information about the Web Input.

      • viewer_urns: string[]

        Identities and groups that are allowed to view all of the Web Input's information.

    • _WebInputRunInfo: { id: string; label: string | null }

      Info about the Run associated with the Web Input.

      • id: string

        Format: uuid

        The unique identifier for the associated Run.

      • label: string | null

        An optional label for the associated Run.

    • _WebInputStatus: "closed" | "open"

      The current status of the Web Input. "open" indicates the Web Input is awaiting a response; "closed" indicates it has been completed.

    • _WebInputTitle: string

      A human-readable title for the Web Input.

    • _WebInputUserRoles: ("viewer" | "respondent")[]

      The roles the current user has on this Web Input.

    • Action: {
          ActionScope?: string;
          ActionUrl: string;
          Catch?: unknown;
          Comment?: unknown;
          End?: unknown;
          ExceptionOnActionFailure: boolean;
          InputPath?: unknown;
          Next?: unknown;
          Parameters?: unknown;
          ResultPath?: unknown;
          RunAs?: string;
          Type: string;
          WaitTime?: number;
      } & { End?: boolean; Next?: string } & {
          Parameters?: { [key: string]: unknown };
      } & { InputPath?: string } & { ResultPath?: string } & {
          Catch?: (
              { ErrorEquals: string[]; Next: string; ResultPath?: unknown } & {
                  ResultPath?: string;
              }
          )[];
      }
    • ActivityNotificationPolicy: { status: ("SUCCEEDED" | "FAILED" | "INACTIVE")[] }

      Activity notification policy

      The email notification policy for the run.

      • status: ("SUCCEEDED" | "FAILED" | "INACTIVE")[]

        The set of statuses on which to notify the run's owner by email.

        [
              "INACTIVE"
            ]
    • BatchRunUpdateOperation: { run_managers?: string[]; run_monitors?: string[]; tags?: string[] }
    • BatchRunUpdateSetOperation: {
          run_managers?: string[];
          run_monitors?: string[];
          status?: "cancel";
          tags?: string[];
      }
    • Catch: {
          Catch?: (
              { ErrorEquals: string[]; Next: string; ResultPath?: unknown } & {
                  ResultPath?: string;
              }
          )[];
      }
    • Choice: {
          Choices: (
              { Next?: string } & {
                  And?: (
                      { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
                  )[];
                  BooleanEquals?: boolean;
                  BooleanEqualsPath?: string;
                  IsBoolean?: boolean;
                  IsNull?: boolean;
                  IsNumeric?: boolean;
                  IsPresent?: boolean;
                  IsString?: boolean;
                  IsTimestamp?: boolean;
                  Not?: { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; };
                  NumericEquals?: number;
                  NumericEqualsPath?: string;
                  NumericGreaterThan?: number;
                  NumericGreaterThanEquals?: number;
                  NumericGreaterThanEqualsPath?: string;
                  NumericGreaterThanPath?: string;
                  NumericLessThan?: number;
                  NumericLessThanEquals?: number;
                  NumericLessThanEqualsPath?: string;
                  NumericLessThanPath?: string;
                  Or?: (
                      { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
                  )[];
                  StringEquals?: string;
                  StringEqualsPath?: string;
                  StringGreaterThan?: string;
                  StringGreaterThanEquals?: string;
                  StringGreaterThanEqualsPath?: string;
                  StringGreaterThanPath?: string;
                  StringLessThan?: string;
                  StringLessThanEquals?: string;
                  StringLessThanEqualsPath?: string;
                  StringLessThanPath?: string;
                  StringMatches?: string;
                  TimestampEquals?: string;
                  TimestampEqualsPath?: string;
                  TimestampGreaterThan?: string;
                  TimestampGreaterThanEquals?: string;
                  TimestampGreaterThanEqualsPath?: string;
                  TimestampGreaterThanPath?: string;
                  TimestampLessThan?: string;
                  TimestampLessThanEquals?: string;
                  TimestampLessThanEqualsPath?: string;
                  TimestampLessThanPath?: string;
                  Variable?: string;
              }
          )[];
          Comment?: string;
          Default?: string;
          Type?: string;
      }
    • ChoiceRule: {
          And?: (
              { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
          )[];
          BooleanEquals?: boolean;
          BooleanEqualsPath?: string;
          IsBoolean?: boolean;
          IsNull?: boolean;
          IsNumeric?: boolean;
          IsPresent?: boolean;
          IsString?: boolean;
          IsTimestamp?: boolean;
          Not?: { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; };
          NumericEquals?: number;
          NumericEqualsPath?: string;
          NumericGreaterThan?: number;
          NumericGreaterThanEquals?: number;
          NumericGreaterThanEqualsPath?: string;
          NumericGreaterThanPath?: string;
          NumericLessThan?: number;
          NumericLessThanEquals?: number;
          NumericLessThanEqualsPath?: string;
          NumericLessThanPath?: string;
          Or?: (
              { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
          )[];
          StringEquals?: string;
          StringEqualsPath?: string;
          StringGreaterThan?: string;
          StringGreaterThanEquals?: string;
          StringGreaterThanEqualsPath?: string;
          StringGreaterThanPath?: string;
          StringLessThan?: string;
          StringLessThanEquals?: string;
          StringLessThanEqualsPath?: string;
          StringLessThanPath?: string;
          StringMatches?: string;
          TimestampEquals?: string;
          TimestampEqualsPath?: string;
          TimestampGreaterThan?: string;
          TimestampGreaterThanEquals?: string;
          TimestampGreaterThanEqualsPath?: string;
          TimestampGreaterThanPath?: string;
          TimestampLessThan?: string;
          TimestampLessThanEquals?: string;
          TimestampLessThanEqualsPath?: string;
          TimestampLessThanPath?: string;
          Variable?: string;
      }
      • OptionalAnd?: (
            { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
        )[]
      • OptionalBooleanEquals?: boolean
      • OptionalBooleanEqualsPath?: string
      • OptionalIsBoolean?: boolean
      • OptionalIsNull?: boolean
      • OptionalIsNumeric?: boolean
      • OptionalIsPresent?: boolean
      • OptionalIsString?: boolean
      • OptionalIsTimestamp?: boolean
      • OptionalNot?: { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
      • OptionalNumericEquals?: number
      • OptionalNumericEqualsPath?: string
      • OptionalNumericGreaterThan?: number
      • OptionalNumericGreaterThanEquals?: number
      • OptionalNumericGreaterThanEqualsPath?: string
      • OptionalNumericGreaterThanPath?: string
      • OptionalNumericLessThan?: number
      • OptionalNumericLessThanEquals?: number
      • OptionalNumericLessThanEqualsPath?: string
      • OptionalNumericLessThanPath?: string
      • OptionalOr?: (
            { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
        )[]
      • OptionalStringEquals?: string
      • OptionalStringEqualsPath?: string
      • OptionalStringGreaterThan?: string
      • OptionalStringGreaterThanEquals?: string
      • OptionalStringGreaterThanEqualsPath?: string
      • OptionalStringGreaterThanPath?: string
      • OptionalStringLessThan?: string
      • OptionalStringLessThanEquals?: string
      • OptionalStringLessThanEqualsPath?: string
      • OptionalStringLessThanPath?: string
      • OptionalStringMatches?: string
      • OptionalTimestampEquals?: string

        Format: date-time

      • OptionalTimestampEqualsPath?: string
      • OptionalTimestampGreaterThan?: string

        Format: date-time

      • OptionalTimestampGreaterThanEquals?: string

        Format: date-time

      • OptionalTimestampGreaterThanEqualsPath?: string
      • OptionalTimestampGreaterThanPath?: string
      • OptionalTimestampLessThan?: string

        Format: date-time

      • OptionalTimestampLessThanEquals?: string

        Format: date-time

      • OptionalTimestampLessThanEqualsPath?: string
      • OptionalTimestampLessThanPath?: string
      • OptionalVariable?: string
    • ExpressionEval: {
          Comment?: unknown;
          Next: string;
          Parameters: unknown;
          ResultPath: unknown;
          Type?: string;
      } & { Parameters?: { [key: string]: unknown } } & { ResultPath?: string }
    • Fail: { Cause?: string; Comment?: string; Error?: string; Type?: string }
    • FlowDefinition: {
          Comment?: string;
          StartAt: string;
          States: {
              [key: string]:
                  | {
                      Comment?: unknown;
                      End?: unknown;
                      InputPath?: unknown;
                      Next?: unknown;
                      Parameters?: unknown;
                      ResultPath?: unknown;
                      Type?: string;
                  } & { End?: boolean; Next?: string } & {
                      Parameters?: { [key: string]: unknown };
                  } & { InputPath?: string } & { ResultPath?: string }
                  | {
                      ActionScope?: string;
                      ActionUrl: string;
                      Catch?: unknown;
                      Comment?: unknown;
                      End?: unknown;
                      ExceptionOnActionFailure: boolean;
                      InputPath?: unknown;
                      Next?: unknown;
                      Parameters?: unknown;
                      ResultPath?: unknown;
                      RunAs?: string;
                      Type: string;
                      WaitTime?: number;
                  } & { End?: boolean; Next?: string } & {
                      Parameters?: { [key: string]: unknown };
                  } & { InputPath?: string } & { ResultPath?: string } & {
                      Catch?: (
                          { ErrorEquals: (...)[]; Next: string; ResultPath?: unknown } & {
                              ResultPath?: (...) | (...);
                          }
                      )[];
                  }
                  | {
                      Comment?: unknown;
                      Next?: string;
                      Seconds?: number;
                      SecondsPath?: string;
                      Timestamp?: string;
                      TimestampPath?: string;
                      Type?: string;
                  }
                  | {
                      Choices: (
                          { Next?: string } & {
                              And?: (
                                  { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
                              )[];
                              BooleanEquals?: boolean;
                              BooleanEqualsPath?: string;
                              IsBoolean?: boolean;
                              IsNull?: boolean;
                              IsNumeric?: boolean;
                              IsPresent?: boolean;
                              IsString?: boolean;
                              IsTimestamp?: boolean;
                              Not?: { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; };
                              NumericEquals?: number;
                              NumericEqualsPath?: string;
                              NumericGreaterThan?: number;
                              NumericGreaterThanEquals?: number;
                              NumericGreaterThanEqualsPath?: string;
                              NumericGreaterThanPath?: string;
                              NumericLessThan?: number;
                              NumericLessThanEquals?: number;
                              NumericLessThanEqualsPath?: string;
                              NumericLessThanPath?: string;
                              Or?: (
                                  { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
                              )[];
                              StringEquals?: string;
                              StringEqualsPath?: string;
                              StringGreaterThan?: string;
                              StringGreaterThanEquals?: string;
                              StringGreaterThanEqualsPath?: string;
                              StringGreaterThanPath?: string;
                              StringLessThan?: string;
                              StringLessThanEquals?: string;
                              StringLessThanEqualsPath?: string;
                              StringLessThanPath?: string;
                              StringMatches?: string;
                              TimestampEquals?: string;
                              TimestampEqualsPath?: string;
                              TimestampGreaterThan?: string;
                              TimestampGreaterThanEquals?: string;
                              TimestampGreaterThanEqualsPath?: string;
                              TimestampGreaterThanPath?: string;
                              TimestampLessThan?: string;
                              TimestampLessThanEquals?: string;
                              TimestampLessThanEqualsPath?: string;
                              TimestampLessThanPath?: string;
                              Variable?: string;
                          }
                      )[];
                      Comment?: string;
                      Default?: string;
                      Type?: string;
                  }
                  | {
                      Comment?: unknown;
                      Next: string;
                      Parameters: unknown;
                      ResultPath: unknown;
                      Type?: string;
                  } & { Parameters?: { [key: string]: unknown } } & { ResultPath?: string }
                  | { Cause?: string; Comment?: string; Error?: string; Type?: string };
          };
      }

      The flow definition

      The flow definition.

      If this parameter is used when updating a flow,
runs that are currently executing will continue to use the definition
that they were initially started with.
    • FlowEmbed: {
          created_at: string;
          deleted_at?: string;
          description?: string;
          flow_owner?: string;
          id: string;
          keywords?: string[];
          subtitle?: string;
          title: string;
          updated_at?: string;
      }
      • created_at: string

        Format: date-time

        A timezone-aware ISO8601 format string that represents the time at which the Flow was created.

      • Optionaldeleted_at?: string

        Format: date-time

        A timezone-aware ISO8601 format string that represents the time at which the Flow was deleted (not present if the Flow has not been deleted).

      • Optionaldescription?: string

        A detailed description of the Flow for end user display.

      • Optionalflow_owner?: string
      • id: string

        The unique identifier for the Flow.

      • Optionalkeywords?: string[]

        A set of terms used to categorize the Flow which may be used in query and discovery operations.

      • Optionalsubtitle?: string

        A concise summary of the Flow's purpose.

      • title: string

        A non-unique, human-friendly name used for displaying the Flow to end users.

      • Optionalupdated_at?: string

        Format: date-time

        A timezone-aware ISO8601 format string that represents the time at which the Flow was last updated.

    • FlowResponse: {
          api_version?: "1.0";
          created_at?: string;
          definition?: {
              Comment?: string;
              StartAt: string;
              States: {
                  [key: string]:
                      | {
                          Comment?: unknown;
                          End?: unknown;
                          InputPath?: unknown;
                          Next?: unknown;
                          Parameters?: unknown;
                          ResultPath?: unknown;
                          Type?: string;
                      } & { End?: boolean; Next?: string } & {
                          Parameters?: { [key: string]: unknown };
                      } & { InputPath?: string } & { ResultPath?: string }
                      | {
                          ActionScope?: string;
                          ActionUrl: string;
                          Catch?: unknown;
                          Comment?: unknown;
                          End?: unknown;
                          ExceptionOnActionFailure: boolean;
                          InputPath?: unknown;
                          Next?: unknown;
                          Parameters?: unknown;
                          ResultPath?: unknown;
                          RunAs?: string;
                          Type: string;
                          WaitTime?: number;
                      } & { End?: boolean; Next?: string } & {
                          Parameters?: { [key: string]: unknown };
                      } & { InputPath?: string } & { ResultPath?: string } & {
                          Catch?: ((...) & (...))[];
                      }
                      | {
                          Comment?: unknown;
                          Next?: string;
                          Seconds?: number;
                          SecondsPath?: string;
                          Timestamp?: string;
                          TimestampPath?: string;
                          Type?: string;
                      }
                      | {
                          Choices: (
                              { Next?: (...)
                              | (...) } & {
                                  And?: (...) | (...);
                                  BooleanEquals?: (...) | (...) | (...);
                                  BooleanEqualsPath?: (...) | (...);
                                  IsBoolean?: (...) | (...) | (...);
                                  IsNull?: (...) | (...) | (...);
                                  IsNumeric?: (...) | (...) | (...);
                                  IsPresent?: (...) | (...) | (...);
                                  IsString?: (...) | (...) | (...);
                                  IsTimestamp?: (...) | (...) | (...);
                                  Not?: (...) | (...);
                                  NumericEquals?: (...) | (...);
                                  NumericEqualsPath?: (...) | (...);
                                  NumericGreaterThan?: (...) | (...);
                                  NumericGreaterThanEquals?: (...) | (...);
                                  NumericGreaterThanEqualsPath?: (...) | (...);
                                  NumericGreaterThanPath?: (...) | (...);
                                  NumericLessThan?: (...) | (...);
                                  NumericLessThanEquals?: (...) | (...);
                                  NumericLessThanEqualsPath?: (...) | (...);
                                  NumericLessThanPath?: (...) | (...);
                                  Or?: (...) | (...);
                                  StringEquals?: (...) | (...);
                                  StringEqualsPath?: (...) | (...);
                                  StringGreaterThan?: (...) | (...);
                                  StringGreaterThanEquals?: (...) | (...);
                                  StringGreaterThanEqualsPath?: (...) | (...);
                                  StringGreaterThanPath?: (...) | (...);
                                  StringLessThan?: (...) | (...);
                                  StringLessThanEquals?: (...) | (...);
                                  StringLessThanEqualsPath?: (...) | (...);
                                  StringLessThanPath?: (...) | (...);
                                  StringMatches?: (...) | (...);
                                  TimestampEquals?: (...) | (...);
                                  TimestampEqualsPath?: (...) | (...);
                                  TimestampGreaterThan?: (...) | (...);
                                  TimestampGreaterThanEquals?: (...) | (...);
                                  TimestampGreaterThanEqualsPath?: (...) | (...);
                                  TimestampGreaterThanPath?: (...) | (...);
                                  TimestampLessThan?: (...) | (...);
                                  TimestampLessThanEquals?: (...) | (...);
                                  TimestampLessThanEqualsPath?: (...) | (...);
                                  TimestampLessThanPath?: (...) | (...);
                                  Variable?: (...) | (...);
                              }
                          )[];
                          Comment?: string;
                          Default?: string;
                          Type?: string;
                      }
                      | {
                          Comment?: unknown;
                          Next: string;
                          Parameters: unknown;
                          ResultPath: unknown;
                          Type?: string;
                      } & { Parameters?: { [key: string]: unknown } } & {
                          ResultPath?: string;
                      }
                      | { Cause?: string; Comment?: string; Error?: string; Type?: string };
              };
          };
          description?: string;
          flow_administrators?: string[];
          flow_owner?: string;
          flow_starters?: string[];
          flow_url?: string;
          flow_viewers?: string[];
          globus_auth_scope?: string;
          globus_auth_scopes_by_RunAs?: string[];
          globus_auth_username?: string;
          id?: string;
          input_schema?: Record<string, unknown>
          | null;
          is_high_assurance?: boolean;
          keywords?: string[];
          log_supported?: boolean;
          principal_urn?: string;
          subscription_id?: string;
          subtitle?: string;
          synchronous?: boolean;
          title?: string;
          types?: ("Action" | "Event")[];
          updated_at?: string;
          user_role?:
              | "flow_owner"
              | "flow_viewer"
              | "flow_starter"
              | "flow_administrator"
              | "run_manager"
              | "run_monitor";
          user_roles?: (
              | "flow_owner"
              | "flow_viewer"
              | "flow_starter"
              | "flow_administrator"
              | "flow_run_manager"
              | "flow_run_monitor"
          )[];
      }
      • Optionalapi_version?: "1.0"
      • Optionalcreated_at?: string

        Format: date-time

        A timezone-aware ISO8601 format string that represents the time at which the Flow was created.

      • Optionaldefinition?: {
            Comment?: string;
            StartAt: string;
            States: {
                [key: string]:
                    | {
                        Comment?: unknown;
                        End?: unknown;
                        InputPath?: unknown;
                        Next?: unknown;
                        Parameters?: unknown;
                        ResultPath?: unknown;
                        Type?: string;
                    } & { End?: boolean; Next?: string } & {
                        Parameters?: { [key: string]: unknown };
                    } & { InputPath?: string } & { ResultPath?: string }
                    | {
                        ActionScope?: string;
                        ActionUrl: string;
                        Catch?: unknown;
                        Comment?: unknown;
                        End?: unknown;
                        ExceptionOnActionFailure: boolean;
                        InputPath?: unknown;
                        Next?: unknown;
                        Parameters?: unknown;
                        ResultPath?: unknown;
                        RunAs?: string;
                        Type: string;
                        WaitTime?: number;
                    } & { End?: boolean; Next?: string } & {
                        Parameters?: { [key: string]: unknown };
                    } & { InputPath?: string } & { ResultPath?: string } & {
                        Catch?: ((...) & (...))[];
                    }
                    | {
                        Comment?: unknown;
                        Next?: string;
                        Seconds?: number;
                        SecondsPath?: string;
                        Timestamp?: string;
                        TimestampPath?: string;
                        Type?: string;
                    }
                    | {
                        Choices: (
                            { Next?: (...)
                            | (...) } & {
                                And?: (...) | (...);
                                BooleanEquals?: (...) | (...) | (...);
                                BooleanEqualsPath?: (...) | (...);
                                IsBoolean?: (...) | (...) | (...);
                                IsNull?: (...) | (...) | (...);
                                IsNumeric?: (...) | (...) | (...);
                                IsPresent?: (...) | (...) | (...);
                                IsString?: (...) | (...) | (...);
                                IsTimestamp?: (...) | (...) | (...);
                                Not?: (...) | (...);
                                NumericEquals?: (...) | (...);
                                NumericEqualsPath?: (...) | (...);
                                NumericGreaterThan?: (...) | (...);
                                NumericGreaterThanEquals?: (...) | (...);
                                NumericGreaterThanEqualsPath?: (...) | (...);
                                NumericGreaterThanPath?: (...) | (...);
                                NumericLessThan?: (...) | (...);
                                NumericLessThanEquals?: (...) | (...);
                                NumericLessThanEqualsPath?: (...) | (...);
                                NumericLessThanPath?: (...) | (...);
                                Or?: (...) | (...);
                                StringEquals?: (...) | (...);
                                StringEqualsPath?: (...) | (...);
                                StringGreaterThan?: (...) | (...);
                                StringGreaterThanEquals?: (...) | (...);
                                StringGreaterThanEqualsPath?: (...) | (...);
                                StringGreaterThanPath?: (...) | (...);
                                StringLessThan?: (...) | (...);
                                StringLessThanEquals?: (...) | (...);
                                StringLessThanEqualsPath?: (...) | (...);
                                StringLessThanPath?: (...) | (...);
                                StringMatches?: (...) | (...);
                                TimestampEquals?: (...) | (...);
                                TimestampEqualsPath?: (...) | (...);
                                TimestampGreaterThan?: (...) | (...);
                                TimestampGreaterThanEquals?: (...) | (...);
                                TimestampGreaterThanEqualsPath?: (...) | (...);
                                TimestampGreaterThanPath?: (...) | (...);
                                TimestampLessThan?: (...) | (...);
                                TimestampLessThanEquals?: (...) | (...);
                                TimestampLessThanEqualsPath?: (...) | (...);
                                TimestampLessThanPath?: (...) | (...);
                                Variable?: (...) | (...);
                            }
                        )[];
                        Comment?: string;
                        Default?: string;
                        Type?: string;
                    }
                    | {
                        Comment?: unknown;
                        Next: string;
                        Parameters: unknown;
                        ResultPath: unknown;
                        Type?: string;
                    } & { Parameters?: { [key: string]: unknown } } & { ResultPath?: string }
                    | { Cause?: string; Comment?: string; Error?: string; Type?: string };
            };
        }

        The flow definition. This is null for High Assurance flows when listing flows.

      • Optionaldescription?: string

        A detailed description of the Flow for end user display.

      • Optionalflow_administrators?: string[]

        The set of Principal URN values of users who may perform administrative operations, including updating the description itself. Only calling users with the "administrator" role will be provided this list. Otherwise, the value will always be an empty list.

      • Optionalflow_owner?: string
      • Optionalflow_starters?: string[]

        A set of Principal URN values, or the value "all_authenticated_users" indicating the identity of users who can initiate a run of the Flow. Only calling users with the "administrator" role will be provided this list. Otherwise, the value will always be an empty list.

        [
              "all_authenticated_users",
              "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
              "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
            ]
      • Optionalflow_url?: string

        Format: uri

        The web-addressable location at which this Flow can be referenced and run from.

      • Optionalflow_viewers?: string[]

        A set of Principal URN values, or the value "public" indicating the identity of users who can view the Flow definition. Only calling users with the "administrator" role will be provided this list. Otherwise, the value will always be an empty list.

        [
              "public",
              "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
              "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
            ]
      • Optionalglobus_auth_scope?: string

        Format: uri

        The scope of any bearer token to be used on authenticated accesses to the Flow.

      • Optionalglobus_auth_scopes_by_RunAs?: string[]

        A list of scopes according to RunAs values as defined in the Flow.

      • Optionalglobus_auth_username?: string

        The Flow's Globus Auth username.

      • Optionalid?: string

        The unique identifier for the Flow.

      • Optionalinput_schema?: Record<string, unknown> | null

        A JSON Schema compliant definition of the format of the body field when requesting a Flow be run. This is null for High Assurance flows when listing flows.

      • Optionalis_high_assurance?: boolean

        Indicates whether this flow is High Assurance. High Assurance flows have sensitive fields (definition, input_schema) omitted from list responses for security purposes.

      • Optionalkeywords?: string[]

        A set of terms used to categorize the Flow which may be used in query and discovery operations.

      • Optionallog_supported?: boolean

        True if the Flow supports the /log operation providing detailed information on the intermediate states of a Flow invocation.

      • Optionalprincipal_urn?: string
      • Optionalsubscription_id?: string

        Format: uuid

        A subscription_id associated with this Flow. If no subscription_id is present, the Flow may be accepted, but may have limits on how long or how much it can be used.

      • Optionalsubtitle?: string

        A concise summary of the Flow's purpose.

      • Optionalsynchronous?: boolean
      • Optionaltitle?: string

        A non-unique, human-friendly name used for displaying the Flow to end users.

      • Optionaltypes?: ("Action" | "Event")[]
      • Optionalupdated_at?: string

        Format: date-time

        A timezone-aware ISO8601 format string that represents the time at which the Flow was last updated.

      • Optionaluser_role?:
            | "flow_owner"
            | "flow_viewer"
            | "flow_starter"
            | "flow_administrator"
            | "run_manager"
            | "run_monitor"

        The role the requesting user has on the Flow.

      • Optionaluser_roles?: (
            | "flow_owner"
            | "flow_viewer"
            | "flow_starter"
            | "flow_administrator"
            | "flow_run_manager"
            | "flow_run_monitor"
        )[]

        The list of all roles the requesting user has on the Flow.

    • FlowRun: {
          action_id: string;
          blocking_web_input_id: string | null;
          completion_time: string;
          details: Record<string, unknown> | null;
          display_status?: string;
          flow_id: string;
          flow_last_updated: string;
          label: string;
          run_id: string;
          run_managers?: string[];
          run_monitors?: string[];
          run_owner: string;
          start_time: string;
          status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED";
          tags: string[];
          user_role:
              | "run_manager"
              | "run_monitor"
              | "run_owner"
              | "flow_run_manager"
              | "flow_run_monitor";
          user_roles?: (
              | "run_manager"
              | "run_monitor"
              | "run_owner"
              | "flow_run_manager"
              | "flow_run_monitor"
          )[];
      }
      • action_id: string

        The ID for a particular Flow invocation. Analogous to a run_id.

      • blocking_web_input_id: string | null

        The ID of the Web Input from which the Run is currently awaiting input. This field is present, but null, if the Run is not awaiting input.

      • completion_time: string

        Format: date-time

        A timezone-aware ISO8601 format string that represents the time at which this Run reached a completed status.

      • details: Record<string, unknown> | null

        Details about the run execution. This is null for runs of High Assurance flows when listing runs.

      • Optionaldisplay_status?: string
      • flow_id: string

        The Flow to which this Run belongs.

      • flow_last_updated: string

        Format: date-time

        A timezone-aware ISO8601 format string that represents the time at which the last update to this Run's Flow occurred.

      • label: string
      • run_id: string

        The ID for a particular Flow invocation. Analogous to an action_id.

      • Optionalrun_managers?: string[]
      • Optionalrun_monitors?: string[]
      • run_owner: string
      • start_time: string

        Format: date-time

        A timezone-aware ISO8601 format string that represents the time at which this Run started.

      • status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED"

        The current state of the Run.

      • tags: string[]
      • user_role:
            | "run_manager"
            | "run_monitor"
            | "run_owner"
            | "flow_run_manager"
            | "flow_run_monitor"

        The role the requesting user has on the Run.

      • Optionaluser_roles?: (
            | "run_manager"
            | "run_monitor"
            | "run_owner"
            | "flow_run_manager"
            | "flow_run_monitor"
        )[]

        The list of all roles the requesting user has on the Run.

    • FlowRunWithFlowEmbed: {
          action_id: string;
          blocking_web_input_id: string | null;
          completion_time: string;
          details: Record<string, unknown> | null;
          display_status?: string;
          flow_id: string;
          flow_last_updated: string;
          label: string;
          run_id: string;
          run_managers?: string[];
          run_monitors?: string[];
          run_owner: string;
          start_time: string;
          status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED";
          tags: string[];
          user_role:
              | "run_manager"
              | "run_monitor"
              | "run_owner"
              | "flow_run_manager"
              | "flow_run_monitor";
          user_roles?: (
              | "run_manager"
              | "run_monitor"
              | "run_owner"
              | "flow_run_manager"
              | "flow_run_monitor"
          )[];
      } & {
          flow_description?: {
              created_at: string;
              deleted_at?: string;
              description?: string;
              flow_owner?: string;
              id: string;
              keywords?: string[];
              subtitle?: string;
              title: string;
              updated_at?: string;
          };
      }
    • FlowScopes: { [key: string]: string[] }
    • FlowValidationErrorResponse: {
          debug_id: string;
          error: {
              code: string;
              detail: string | { loc: string[]; msg: string; type: string }[];
              message?: string;
          };
      }
      • debug_id: string

        A unique identifier for the validation error, used for debugging.

      • error: {
            code: string;
            detail: string | { loc: string[]; msg: string; type: string }[];
            message?: string;
        }
        • code: string

          A readable keyword describing the failure.

        • detail: string | { loc: string[]; msg: string; type: string }[]

          An array of failure objects, describing what failed.

        • Optionalmessage?: string

          A human-readable message providing more context about the failure.

    • FlowValidationResponse: { scopes?: { [key: string]: string[] } }
    • GetRunDefinitionResponse: {
          definition: Record<string, unknown>;
          flow_id: string;
          input_schema: Record<string, unknown>;
      }
      • definition: Record<string, unknown>

        The definition of the Flow at the time the Run was started.

      • flow_id: string

        The Flow used to start the Run.

      • input_schema: Record<string, unknown>

        The input schema of the Flow at the time the Run was started.

    • InputBody: { [key: string]: unknown }

      Input body

      The input body that will be passed into the flow when it starts. If the flow defines an input schema, the input body will be validated against the input schema. If there is no input schema, no validation will be performed.

    • InputPath: { InputPath?: string }
    • JsonPathPattern: string
    • Label: string

      Label

      A short, human-readable description of the run.

      Generate a report for experiment xDA202-batch-3
    • LocationErrorList: { loc: string[]; msg: string; type: string }[]
    • NextOrEnd: { End?: boolean; Next?: string }
    • Parameters: { Parameters?: { [key: string]: unknown } }
    • ParametersOrInputPath: { Parameters?: { [key: string]: unknown } } & { InputPath?: string }
    • ParametersOrInputPathNotRequired: { Parameters?: { [key: string]: unknown } } & { InputPath?: string }
    • Pass: {
          Comment?: unknown;
          End?: unknown;
          InputPath?: unknown;
          Next?: unknown;
          Parameters?: unknown;
          ResultPath?: unknown;
          Type?: string;
      } & { End?: boolean; Next?: string } & {
          Parameters?: { [key: string]: unknown };
      } & { InputPath?: string } & { ResultPath?: string }
    • PrincipalURN: string

      A URN representation of an Identity in Globus either of a user from Globus Auth or a group from Globus Groups.

      urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c
    • RegisteredApi: {
          created_timestamp: string;
          description: string;
          id: string;
          name: string;
          updated_timestamp: string;
      } & {
          data_templates: {
              request: { [key: string]: unknown };
              response: { [key: string]: unknown };
          };
          edited_timestamp?: string
          | null;
          roles: { administrators?: string[]; owners?: string[]; viewers?: string[] };
          scheduled_deletion_timestamp?: string | null;
          state_input_schema: { [key: string]: unknown };
          status: "ACTIVE" | "INACTIVE";
          subscription_id: string | null;
          target: {
              components?: { [key: string]: unknown };
              destination: {
                  method: "delete" | "get" | "post" | "put" | "patch";
                  url: string;
              };
              openapi_version: string;
              specification: { [key: string]: unknown };
              type: "openapi";
          };
      }
    • RegisteredApiSummary: {
          created_timestamp: string;
          description: string;
          id: string;
          name: string;
          updated_timestamp: string;
      }
      • created_timestamp: string

        Format: date-time

        A timezone-aware ISO8601 format string that represents the time at which the Registered API was created.

      • description: string

        A detailed description of the Registered API.

      • id: string

        Format: uuid

        The unique identifier for the Registered API.

      • name: string

        A non-unique, human-friendly name used for displaying the Registered API to end users.

      • updated_timestamp: string

        Format: date-time

        A timezone-aware ISO8601 format string that represents the time at which the Registered API was last updated.

    • ResultPath: { ResultPath?: string }
    • RunManagers: string[]

      Run managers

      A list of Globus Auth identity and group URNs that may manage runs of the flow.

      "Managing" operations include updating, canceling, and deleting the run.

Only users with the "run_manager" role will be able to view this list.
Users with only the "run_monitor" role will see an empty list.
    • RunMonitors: string[]

      Run monitors

      A list of Globus Auth identity and group URNs that may monitor runs of the flow.

      "Monitoring" operations include checking the run status and its logs.

Only users with the "run_manager" role will be able to view this list.
Users with only the "run_monitor" role will see an empty list.
    • RunUpdate: {
          label?: string;
          run_managers?: string[];
          run_monitors?: string[];
          tags?: string[];
      }
    • Tags: string[]

      Tags

      A list of tags to associate with the run.

      Tags are normalized by stripping leading and trailing whitespace,
and by replacing all whitespace with a single space.

When updating a run, existing tags will be overwritten.
This means that an empty array will delete all existing tags.

      [
            "Experiment:xDA202",
            "Site:Nautilus",
            "Friday COB Report"
          ]
    • ValidateRun: { message: string }
      • message: string

        A message indicating the validation was successful

        success
    • Wait: {
          Comment?: unknown;
          Next?: string;
          Seconds?: number;
          SecondsPath?: string;
          Timestamp?: string;
          TimestampPath?: string;
          Type?: string;
      }
      • OptionalComment?: unknown
      • OptionalNext?: string
      • OptionalSeconds?: number
      • OptionalSecondsPath?: string
      • OptionalTimestamp?: string

        Format: date-time

      • OptionalTimestampPath?: string
      • OptionalType?: string
    • WebInputResponse: {
          closed_timestamp: string | null;
          context: {
              presentation_style?: string;
              rows?: { field: string; value: string }[];
              title?: string;
          };
          created_timestamp: string;
          creator_urn: string;
          edited_timestamp: string;
          flow: { id: string; title: string };
          id: string;
          input_schema: Record<string, unknown>;
          input_type: "selection";
          options?: { description: string; label: string; option_id: string }[];
          roles: { respondent_urns: string[]; viewer_urns: string[] };
          run: { id: string; label: string | null };
          status: "closed" | "open";
          user_roles: ("viewer" | "respondent")[];
      }
      • closed_timestamp: string | null
      • context: {
            presentation_style?: string;
            rows?: { field: string; value: string }[];
            title?: string;
        }
        • Optionalpresentation_style?: string

          The suggested way by which the rows should be rendered for display.

        • Optionalrows?: { field: string; value: string }[]
        • Optionaltitle?: string

          A title for the Web Input. This may be displayed as an human-readable label for the Web Input itself, or it may be used as a bold header on a webpage displaying the Web Input as a form.

      • created_timestamp: string
      • creator_urn: string
      • edited_timestamp: string
      • flow: { id: string; title: string }
        • id: string

          Format: uuid

          The unique identifier for the associated Flow.

        • title: string

          The title of the associated Flow.

      • id: string
      • input_schema: Record<string, unknown>
      • input_type: "selection"
      • Optionaloptions?: { description: string; label: string; option_id: string }[]
      • roles: { respondent_urns: string[]; viewer_urns: string[] }
        • respondent_urns: string[]

          Identities and groups that are allowed to submit responses to the Web Input. Respondents are also allowed to view information about the Web Input.

        • viewer_urns: string[]

          Identities and groups that are allowed to view all of the Web Input's information.

      • run: { id: string; label: string | null }
        • id: string

          Format: uuid

          The unique identifier for the associated Run.

        • label: string | null

          An optional label for the associated Run.

      • status: "closed" | "open"
      • user_roles: ("viewer" | "respondent")[]
    • WebInputSummary: {
          closed_timestamp: string | null;
          created_timestamp: string;
          edited_timestamp: string;
          flow: { id: string; title: string };
          id: string;
          input_type: "selection";
          run: { id: string; label: string | null };
          status: "closed" | "open";
          title: string;
          user_roles: ("viewer" | "respondent")[];
      }
      • closed_timestamp: string | null
      • created_timestamp: string
      • edited_timestamp: string
      • flow: { id: string; title: string }
        • id: string

          Format: uuid

          The unique identifier for the associated Flow.

        • title: string

          The title of the associated Flow.

      • id: string
      • input_type: "selection"
      • run: { id: string; label: string | null }
        • id: string

          Format: uuid

          The unique identifier for the associated Run.

        • label: string | null

          An optional label for the associated Run.

      • status: "closed" | "open"
      • title: string
      • user_roles: ("viewer" | "respondent")[]

    Settings

    Member Visibility

    On This Page

    Properties