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[];
        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: {
        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;
            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;
            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;
        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;
        };
    };
}

Index

Properties

headers parameters pathItems requestBodies responses schemas

Properties

headers

headers: never

parameters

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[];
    run_id: string;
}

Type Declaration

filter_completion_time: string

Description

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.

Example

2021-03-09T21:52:14,2021-03-09T21:53

filter_start_time: string

Description

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.

Example

2021-03-09T21:52:14,2021-03-09T21:53

flow_id: string
Description
The flow ID

list_flows_orderby: string[]

Description

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`

Example

[
      "title ASC",
      "id DESC"
    ]

list_registered_apis_orderby: string[]

Description

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`

Example

[
      "name ASC",
      "id DESC"
    ]

list_runs_orderby: string[]

Description

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`

Example

[
      "start_time ASC",
      "id DESC"
    ]

run_id: string
Description
The run ID

pathItems

pathItems: never

requestBodies

requestBodies: never

responses

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 };
}

Description

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 };
}
Description
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 };
}
Description
The input document failed input validation in some way.

schemas

schemas: {
    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;
        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;
        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;
    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;
    };
}

Type Declaration

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

Description
The email notification policy for the run.
- status: ("SUCCEEDED" | "FAILED" | "INACTIVE")[]
  Description
  The set of statuses on which to notify the run's owner by email.
  Default
```
[
      "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
Description
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
  
  Description
  A timezone-aware ISO8601 format string that represents the time at which the Flow was created.
- Optionaldeleted_at?: string
  Format: date-time
  
  Description
  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
  Description
  A detailed description of the Flow for end user display.
- Optionalflow_owner?: string
- id: string
  Description
  The unique identifier for the Flow.
- Optionalkeywords?: string[]
  Description
  A set of terms used to categorize the Flow which may be used in query and discovery operations.
- Optionalsubtitle?: string
  Description
  A concise summary of the Flow's purpose.
- title: string
  Description
  A non-unique, human-friendly name used for displaying the Flow to end users.
- Optionalupdated_at?: string
  Format: date-time
  
  Description
  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
  
  Description
  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 };
      };
  }
  Description
  The flow definition. This is null for High Assurance flows when listing flows.
- Optionaldescription?: string
  Description
  A detailed description of the Flow for end user display.
- Optionalflow_administrators?: string[]
  Description
  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[]
  Description
  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.
  Example
```
[
      "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
  
  Description
  The web-addressable location at which this Flow can be referenced and run from.
- Optionalflow_viewers?: string[]
  Description
  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.
  Example
```
[
      "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
  
  Description
  The scope of any bearer token to be used on authenticated accesses to the Flow.
- Optionalglobus_auth_scopes_by_RunAs?: string[]
  Description
  A list of scopes according to RunAs values as defined in the Flow.
- Optionalglobus_auth_username?: string
  Description
  The Flow's Globus Auth username.
- Optionalid?: string
  Description
  The unique identifier for the Flow.
- Optionalinput_schema?: Record<string, unknown> | null
  Description
  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
  Description
  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[]
  Description
  A set of terms used to categorize the Flow which may be used in query and discovery operations.
- Optionallog_supported?: boolean
  Description
  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
  
  Description
  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
  Description
  A concise summary of the Flow's purpose.
- Optionalsynchronous?: boolean
- Optionaltitle?: string
  Description
  A non-unique, human-friendly name used for displaying the Flow to end users.
- Optionaltypes?: ("Action" | "Event")[]
- Optionalupdated_at?: string
  Format: date-time
  
  Description
  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"
  Deprecated
  Description
  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"
  )[]
  Description
  The list of all roles the requesting user has on the Flow.
FlowRun: {
    action_id: string;
    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
  Description
  The ID for a particular Flow invocation. Analogous to a run_id.
- completion_time: string
  Format: date-time
  
  Description
  A timezone-aware ISO8601 format string that represents the time at which this Run reached a completed status.
- details: Record<string, unknown> | null
  Description
  Details about the run execution. This is null for runs of High Assurance flows when listing runs.
- Optionaldisplay_status?: string
- flow_id: string
  Description
  The Flow to which this Run belongs.
- flow_last_updated: string
  Format: date-time
  
  Description
  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
  Description
  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
  
  Description
  A timezone-aware ISO8601 format string that represents the time at which this Run started.
- status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED"
  Description
  The current state of the Run.
- tags: string[]
- user_role:
      | "run_manager"
      | "run_monitor"
      | "run_owner"
      | "flow_run_manager"
      | "flow_run_monitor"
  Deprecated
  Description
  The role the requesting user has on the Run.
- Optionaluser_roles?: (
      | "run_manager"
      | "run_monitor"
      | "run_owner"
      | "flow_run_manager"
      | "flow_run_monitor"
  )[]
  Description
  The list of all roles the requesting user has on the Run.
FlowRunWithFlowEmbed: {
    action_id: string;
    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
  Description
  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
    Description
    A readable keyword describing the failure.
  - detail: string | { loc: string[]; msg: string; type: string }[]
    An array of failure objects, describing what failed.
  - Optionalmessage?: string
    Description
    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>
  Description
  The definition of the Flow at the time the Run was started.
- flow_id: string
  Description
  The Flow used to start the Run.
- input_schema: Record<string, unknown>
  Description
  The input schema of the Flow at the time the Run was started.
InputBody: { [key: string]: unknown }
Input body

Description
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
Description
A short, human-readable description of the run.
Example
```
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
Description
A URN representation of an Identity in Globus either of a user from Globus Auth or a group from Globus Groups.
Example
```
urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c
```
RegisteredApiSummary: {
    created_timestamp: string;
    description: string;
    id: string;
    name: string;
    updated_timestamp: string;
}
- created_timestamp: string
  Format: date-time
  
  Description
  A timezone-aware ISO8601 format string that represents the time at which the Registered API was created.
- description: string
  Description
  A detailed description of the Registered API.
- id: string
  Format: uuid
  
  Description
  The unique identifier for the Registered API.
- name: string
  Description
  A non-unique, human-friendly name used for displaying the Registered API to end users.
- updated_timestamp: string
  Format: date-time
  
  Description
  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

Description

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

Description

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[]

Description

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.

Example

[
      "Experiment:xDA202",
      "Site:Nautilus",
      "Friday COB Report"
    ]

ValidateRun: { message: string }
- message: string
  Description
  A message indicating the validation was successful
  Example
```
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

Interface components

Index

Properties

Properties

headers

parameters

Type Declaration

filter_completion_time: string

Description

Example

filter_start_time: string

Description

Example

flow_id: string

Description

list_flows_orderby: string[]

Description

Example

list_registered_apis_orderby: string[]

Description

Example

list_runs_orderby: string[]

Description

Example

run_id: string

Description

pathItems

requestBodies

responses

Type Declaration

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

Description

HTTP403Response: { content: { "application/json": { error: { code: string; detail: string } }; }; headers: { [name: string]: unknown };}

Description

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

Description

schemas

Type Declaration

ActivityNotificationPolicy: { status: ("SUCCEEDED" | "FAILED" | "INACTIVE")[] }

Description

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

Description

Default

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; } )[];}

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

OptionalTimestampEqualsPath?: string

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 };
}

BatchRunUpdateSetOperation: {
run_managers?: string[];
run_monitors?: string[];
status?: "cancel";
tags?: string[];
}

Catch: {
Catch?: (
{ ErrorEquals: string[]; Next: string; ResultPath?: unknown } & {
ResultPath?: string;
}
)[];
}

`Optional`And?: (
{ And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
)[]

`Optional`BooleanEquals?: boolean

`Optional`BooleanEqualsPath?: string

`Optional`IsBoolean?: boolean

`Optional`IsNull?: boolean

`Optional`IsNumeric?: boolean

`Optional`IsPresent?: boolean

`Optional`IsString?: boolean

`Optional`IsTimestamp?: boolean

`Optional`Not?: { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }

`Optional`NumericEquals?: number

`Optional`NumericEqualsPath?: string

`Optional`NumericGreaterThan?: number

`Optional`NumericGreaterThanEquals?: number

`Optional`NumericGreaterThanEqualsPath?: string

`Optional`NumericGreaterThanPath?: string

`Optional`NumericLessThan?: number

`Optional`NumericLessThanEquals?: number

`Optional`NumericLessThanEqualsPath?: string

`Optional`NumericLessThanPath?: string

`Optional`Or?: (
{ And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
)[]

`Optional`StringEquals?: string

`Optional`StringEqualsPath?: string

`Optional`StringGreaterThan?: string

`Optional`StringGreaterThanEquals?: string

`Optional`StringGreaterThanEqualsPath?: string

`Optional`StringGreaterThanPath?: string

`Optional`StringLessThan?: string

`Optional`StringLessThanEquals?: string

`Optional`StringLessThanEqualsPath?: string

`Optional`StringLessThanPath?: string

`Optional`StringMatches?: string

`Optional`TimestampEquals?: string

`Optional`TimestampEqualsPath?: string

`Optional`TimestampGreaterThan?: string

`Optional`TimestampGreaterThanEquals?: string

`Optional`TimestampGreaterThanEqualsPath?: string

`Optional`TimestampGreaterThanPath?: string

`Optional`TimestampLessThan?: string

`Optional`TimestampLessThanEquals?: string

`Optional`TimestampLessThanEqualsPath?: string

`Optional`TimestampLessThanPath?: string

`Optional`Variable?: string

ExpressionEval: {
Comment?: unknown;
Next: string;
Parameters: unknown;
ResultPath: unknown;
Type?: string;
} & { Parameters?: { [key: string]: unknown } } & { ResultPath?: string }

FlowEmbed: {
created_at: string;
deleted_at?: string;
description?: string;
flow_owner?: string;
id: string;
keywords?: string[];
subtitle?: string;
title: string;
updated_at?: string;
}

`Optional`deleted_at?: string

`Optional`description?: string

`Optional`flow_owner?: string

`Optional`keywords?: string[]

`Optional`subtitle?: string

`Optional`updated_at?: string

`Optional`api_version?: "1.0"

`Optional`created_at?: string

`Optional`description?: string

`Optional`flow_administrators?: string[]

`Optional`flow_owner?: string

`Optional`flow_starters?: string[]

`Optional`flow_url?: string

`Optional`flow_viewers?: string[]

`Optional`globus_auth_scope?: string

`Optional`globus_auth_scopes_by_RunAs?: string[]

`Optional`globus_auth_username?: string

`Optional`id?: string

`Optional`input_schema?: Record<string, unknown> | null

`Optional`is_high_assurance?: boolean

`Optional`keywords?: string[]

`Optional`log_supported?: boolean

`Optional`principal_urn?: string