Globus SDK for JavaScript
    Preparing search index...

    This file was auto-generated by openapi-typescript. Do not make direct changes to the file.

    interface paths {
        "/batch/runs": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            add?: {
                                run_managers?: string[];
                                run_monitors?: string[];
                                tags?: string[];
                            };
                            filters: { run_ids: string[] };
                            remove?: {
                                run_managers?: string[];
                                run_monitors?: string[];
                                tags?: string[];
                            };
                            set?: {
                                run_managers?: string[];
                                run_monitors?: string[];
                                status?: "cancel";
                                tags?: string[];
                            };
                        };
                    };
                };
                responses: never;
            };
            put?: undefined;
            trace?: undefined;
        };
        "/flows": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: {
                        filter_description?: string[];
                        filter_fulltext?: string[];
                        filter_keywords?: string[];
                        filter_role?: | "flow_owner"
                        | "flow_viewer"
                        | "flow_starter"
                        | "flow_administrator"
                        | "run_manager"
                        | "run_monitor";
                        filter_roles?: (
                            | "flow_owner"
                            | "flow_viewers"
                            | "flow_starters"
                            | "flow_administrators"
                            | "run_managers"
                            | "run_monitors"
                        )[];
                        filter_scope_string?: string[];
                        filter_subtitle?: string[];
                        filter_title?: string[];
                        marker?: string;
                        orderby?: string[];
                        page?: number;
                        per_page?: number;
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                flows?: {
                                    api_version?: "1.0";
                                    created_at?: string;
                                    definition?: { Comment?: ...; StartAt: ...; States: ... };
                                    description?: string;
                                    flow_administrators?: (...)[];
                                    flow_owner?: string;
                                    flow_starters?: (...)[];
                                    flow_url?: string;
                                    flow_viewers?: (...)[];
                                    globus_auth_scope?: string;
                                    globus_auth_scopes_by_RunAs?: (...)[];
                                    globus_auth_username?: string;
                                    id?: string;
                                    input_schema?: Record<(...), (...)>;
                                    keywords?: (...)[];
                                    log_supported?: boolean;
                                    principal_urn?: string;
                                    subscription_id?: string;
                                    subtitle?: string;
                                    synchronous?: boolean;
                                    title?: string;
                                    types?: (...)[];
                                    updated_at?: string;
                                    user_role?:
                                        | "flow_owner"
                                        | "flow_viewer"
                                        | "flow_starter"
                                        | "flow_administrator";
                                }[];
                                has_next_page?: boolean;
                                limit?: number;
                                marker?: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": { content?: undefined; headers: { [name: string]: unknown } };
                    "403": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            definition: {
                                Comment?: string;
                                StartAt: string;
                                States: {
                                    [key: string]: | {
                                        Comment?: unknown;
                                        End?: unknown;
                                        InputPath?: unknown;
                                        Next?: unknown;
                                        Parameters?: unknown;
                                        ResultPath?: unknown;
                                        Type?: (...)
                                        | (...);
                                    } & { End?: (...)
                                    | (...)
                                    | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                        InputPath?: (...) | (...);
                                    } & { ResultPath?: (...)
                                    | (...) }
                                    | {
                                        ActionScope?: (...) | (...);
                                        ActionUrl: string;
                                        Catch?: unknown;
                                        Comment?: unknown;
                                        End?: unknown;
                                        ExceptionOnActionFailure: boolean;
                                        InputPath?: unknown;
                                        Next?: unknown;
                                        Parameters?: unknown;
                                        ResultPath?: unknown;
                                        RunAs?: (...) | (...);
                                        Type: string;
                                        WaitTime?: (...) | (...);
                                    } & { End?: (...)
                                    | (...)
                                    | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                        InputPath?: (...) | (...);
                                    } & { ResultPath?: (...)
                                    | (...) } & { Catch?: (...) | (...) }
                                    | {
                                        Comment?: unknown;
                                        Next?: string;
                                        Seconds?: number;
                                        SecondsPath?: string;
                                        Timestamp?: string;
                                        TimestampPath?: string;
                                        Type?: string;
                                    }
                                    | {
                                        Choices: ((...) & (...))[];
                                        Comment?: string;
                                        Default?: string;
                                        Type?: string;
                                    }
                                    | {
                                        Comment?: unknown;
                                        Next: string;
                                        Parameters: unknown;
                                        ResultPath: unknown;
                                        Type?: (...)
                                        | (...);
                                    } & { Parameters?: (...)
                                    | (...) } & { ResultPath?: (...) | (...) }
                                    | {
                                        Cause?: string;
                                        Comment?: string;
                                        Error?: string;
                                        Type?: string;
                                    };
                                };
                            };
                            description?: string;
                            flow_administrators?: string[];
                            flow_starters?: string[];
                            flow_viewers?: string[];
                            input_schema?: Record<string, never>;
                            keywords?: string[];
                            run_managers?: string[];
                            run_monitors?: string[];
                            subscription_id?: string;
                            subtitle?: string;
                            title?: string;
                        };
                    };
                };
                responses: {
                    "201": {
                        content: {
                            "application/json": {
                                api_version?: "1.0";
                                created_at?: string;
                                definition?: {
                                    Comment?: string;
                                    StartAt: string;
                                    States: {
                                        [key: string]: | (...) & (...) & (...) & (...) & (...)
                                        | (...) & (...) & (...) & (...) & (...) & (...)
                                        | {
                                            Comment?: ...;
                                            Next?: ...;
                                            Seconds?: ...;
                                            SecondsPath?: ...;
                                            Timestamp?: ...;
                                            TimestampPath?: ...;
                                            Type?: ...;
                                        }
                                        | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                        | (...) & (...) & (...)
                                        | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                                    };
                                };
                                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, never>;
                                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";
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": { content?: undefined; headers: { [name: string]: unknown } };
                    "403": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/flows/{flow_id}": {
            delete: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { flow_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                api_version?: "1.0";
                                created_at?: string;
                                definition?: {
                                    Comment?: string;
                                    StartAt: string;
                                    States: {
                                        [key: string]: | (...) & (...) & (...) & (...) & (...)
                                        | (...) & (...) & (...) & (...) & (...) & (...)
                                        | {
                                            Comment?: ...;
                                            Next?: ...;
                                            Seconds?: ...;
                                            SecondsPath?: ...;
                                            Timestamp?: ...;
                                            TimestampPath?: ...;
                                            Type?: ...;
                                        }
                                        | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                        | (...) & (...) & (...)
                                        | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                                    };
                                };
                                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, never>;
                                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";
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": { content?: undefined; headers: { [name: string]: unknown } };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { flow_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                api_version?: "1.0";
                                created_at?: string;
                                definition?: {
                                    Comment?: string;
                                    StartAt: string;
                                    States: {
                                        [key: string]: | (...) & (...) & (...) & (...) & (...)
                                        | (...) & (...) & (...) & (...) & (...) & (...)
                                        | {
                                            Comment?: ...;
                                            Next?: ...;
                                            Seconds?: ...;
                                            SecondsPath?: ...;
                                            Timestamp?: ...;
                                            TimestampPath?: ...;
                                            Type?: ...;
                                        }
                                        | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                        | (...) & (...) & (...)
                                        | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                                    };
                                };
                                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, never>;
                                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";
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": { content?: undefined; headers: { [name: string]: unknown } };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string };
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { flow_id: string };
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            definition?: {
                                Comment?: string;
                                StartAt: string;
                                States: {
                                    [key: string]: | {
                                        Comment?: ...;
                                        End?: ...;
                                        InputPath?: ...;
                                        Next?: ...;
                                        Parameters?: ...;
                                        ResultPath?: ...;
                                        Type?: ...;
                                    } & { End?: ...; Next?: ... } & { Parameters?: ... } & {
                                        InputPath?: ...;
                                    } & { ResultPath?: ... }
                                    | {
                                        ActionScope?: ...;
                                        ActionUrl: ...;
                                        Catch?: ...;
                                        Comment?: ...;
                                        End?: ...;
                                        ExceptionOnActionFailure: ...;
                                        InputPath?: ...;
                                        Next?: ...;
                                        Parameters?: ...;
                                        ResultPath?: ...;
                                        RunAs?: ...;
                                        Type: ...;
                                        WaitTime?: ...;
                                    } & { End?: ...; Next?: ... } & { Parameters?: ... } & {
                                        InputPath?: ...;
                                    } & { ResultPath?: ... } & { Catch?: ... }
                                    | {
                                        Comment?: unknown;
                                        Next?: (...) | (...);
                                        Seconds?: (...) | (...);
                                        SecondsPath?: (...) | (...);
                                        Timestamp?: (...) | (...);
                                        TimestampPath?: (...) | (...);
                                        Type?: (...) | (...);
                                    }
                                    | {
                                        Choices: (...)[];
                                        Comment?: (...) | (...);
                                        Default?: (...) | (...);
                                        Type?: (...) | (...);
                                    }
                                    | {
                                        Comment?: ...;
                                        Next: ...;
                                        Parameters: ...;
                                        ResultPath: ...;
                                        Type?: ...;
                                    } & { Parameters?: ... } & { ResultPath?: ... }
                                    | {
                                        Cause?: (...) | (...);
                                        Comment?: (...) | (...);
                                        Error?: (...) | (...);
                                        Type?: (...) | (...);
                                    };
                                };
                            };
                            description?: string;
                            flow_administrators?: Record<string, never>[];
                            flow_owner?: string;
                            flow_starters?: Record<string, never>[];
                            flow_viewers?: Record<string, never>[];
                            input_schema?: Record<string, never>;
                            keywords?: Record<string, never>[];
                            run_managers?: string[];
                            run_monitors?: string[];
                            subscription_id?: string;
                            subtitle?: string;
                            title?: string;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                api_version?: "1.0";
                                created_at?: string;
                                definition?: {
                                    Comment?: string;
                                    StartAt: string;
                                    States: {
                                        [key: string]: | (...) & (...) & (...) & (...) & (...)
                                        | (...) & (...) & (...) & (...) & (...) & (...)
                                        | {
                                            Comment?: ...;
                                            Next?: ...;
                                            Seconds?: ...;
                                            SecondsPath?: ...;
                                            Timestamp?: ...;
                                            TimestampPath?: ...;
                                            Type?: ...;
                                        }
                                        | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                        | (...) & (...) & (...)
                                        | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                                    };
                                };
                                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, never>;
                                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";
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": { content?: undefined; headers: { [name: string]: unknown } };
                    "403": { content?: undefined; headers: { [name: string]: unknown } };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            trace?: undefined;
        };
        "/flows/{flow_id}/{run_id}/log": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { flow_id: string; run_id: string };
                    query?: {
                        limit?: number;
                        pagination_token?: string;
                        reverse_order?: boolean;
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                entries: Record<string, never>[];
                                has_next_page: boolean;
                                limit: number;
                                marker?: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": { content?: undefined; headers: { [name: string]: unknown } };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string; run_id: string };
                query?: {
                    limit?: number;
                    pagination_token?: string;
                    reverse_order?: boolean;
                };
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/flows/{flow_id}/{run_id}/resume": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string; run_id: string };
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { flow_id: string; run_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                action_id: string;
                                completion_time: string;
                                details: Record<string, never>;
                                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";
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/flows/{flow_id}/actions": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { flow_id: string };
                    query?: {
                        filter_completion_time?: string;
                        filter_label?: string[];
                        filter_role?:
                            | "run_manager"
                            | "run_monitor"
                            | "run_owner"
                            | "flow_run_manager"
                            | "flow_run_monitor";
                        filter_roles?: (
                            | "run_manager"
                            | "run_monitor"
                            | "run_owner"
                            | "flow_run_manager"
                            | "flow_run_monitor"
                        )[];
                        filter_start_time?: string;
                        filter_status?: (
                            "SUCCEEDED"
                            | "FAILED"
                            | "ACTIVE"
                            | "INACTIVE"
                            | "ENDED"
                        )[];
                        marker?: string;
                        orderby?: string[];
                        page?: number;
                        pagination_token?: string;
                        per_page?: number;
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                actions: {
                                    action_id: string;
                                    completion_time: string;
                                    details: Record<string, never>;
                                    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";
                                }[];
                                has_next_page: boolean;
                                marker?: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": { content?: undefined; headers: { [name: string]: unknown } };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string };
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/flows/{flow_id}/actions/{action_id}/log": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { flow_id: string; run_id: string };
                    query?: {
                        limit?: number;
                        pagination_token?: string;
                        reverse_order?: boolean;
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                entries: Record<string, never>[];
                                has_next_page: boolean;
                                limit: number;
                                marker?: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": { content?: undefined; headers: { [name: string]: unknown } };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string; run_id: string };
                query?: {
                    limit?: number;
                    pagination_token?: string;
                    reverse_order?: boolean;
                };
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/flows/{flow_id}/actions/{action_id}/resume": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string; run_id: string };
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { flow_id: string; run_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                action_id: string;
                                completion_time: string;
                                details: Record<string, never>;
                                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";
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/flows/{flow_id}/run": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string };
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { flow_id: string };
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            activity_notification_policy?: {
                                status: ("SUCCEEDED" | "FAILED" | "INACTIVE")[];
                            };
                            body: { [key: string]: unknown };
                            label?: string;
                            run_managers?: string[];
                            run_monitors?: string[];
                            tags?: string[];
                        };
                    };
                };
                responses: {
                    "200": { content?: undefined; headers: { [name: string]: unknown } };
                    "201": {
                        content: {
                            "application/json": {
                                action_id: string;
                                completion_time: string;
                                details: Record<string, never>;
                                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";
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": { content?: undefined; headers: { [name: string]: unknown } };
                    "403": { content?: undefined; headers: { [name: string]: unknown } };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                    "422": { content?: undefined; headers: { [name: string]: unknown } };
                    "429": { content?: undefined; headers: { [name: string]: unknown } };
                    "502": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/flows/{flow_id}/runs": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { flow_id: string };
                    query?: {
                        filter_completion_time?: string;
                        filter_label?: string[];
                        filter_role?:
                            | "run_manager"
                            | "run_monitor"
                            | "run_owner"
                            | "flow_run_manager"
                            | "flow_run_monitor";
                        filter_roles?: (
                            | "run_manager"
                            | "run_monitor"
                            | "run_owner"
                            | "flow_run_manager"
                            | "flow_run_monitor"
                        )[];
                        filter_start_time?: string;
                        filter_status?: (
                            "SUCCEEDED"
                            | "FAILED"
                            | "ACTIVE"
                            | "INACTIVE"
                            | "ENDED"
                        )[];
                        marker?: string;
                        orderby?: string[];
                        page?: number;
                        pagination_token?: string;
                        per_page?: number;
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                actions: {
                                    action_id: string;
                                    completion_time: string;
                                    details: Record<string, never>;
                                    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";
                                }[];
                                has_next_page: boolean;
                                marker?: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": { content?: undefined; headers: { [name: string]: unknown } };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string };
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/flows/{flow_id}/runs/{run_id}/log": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { flow_id: string; run_id: string };
                    query?: {
                        limit?: number;
                        pagination_token?: string;
                        reverse_order?: boolean;
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                entries: Record<string, never>[];
                                has_next_page: boolean;
                                limit: number;
                                marker?: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": { content?: undefined; headers: { [name: string]: unknown } };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string; run_id: string };
                query?: {
                    limit?: number;
                    pagination_token?: string;
                    reverse_order?: boolean;
                };
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/flows/{flow_id}/runs/{run_id}/resume": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string; run_id: string };
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { flow_id: string; run_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                action_id: string;
                                completion_time: string;
                                details: Record<string, never>;
                                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";
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/flows/{flow_id}/start": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string };
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { flow_id: string };
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            body: { [key: string]: unknown };
                            tags?: string[];
                        };
                    };
                };
                responses: {
                    "200": { content?: undefined; headers: { [name: string]: unknown } };
                    "201": {
                        content: {
                            "application/json": {
                                action_id: string;
                                completion_time: string;
                                details: Record<string, never>;
                                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";
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": { content?: undefined; headers: { [name: string]: unknown } };
                    "403": { content?: undefined; headers: { [name: string]: unknown } };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                    "422": { content?: undefined; headers: { [name: string]: unknown } };
                    "429": { content?: undefined; headers: { [name: string]: unknown } };
                    "502": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/flows/{flow_id}/validate_run": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            activity_notification_policy?: {
                                status: ("SUCCEEDED" | "FAILED" | "INACTIVE")[];
                            };
                            body: { [key: string]: unknown };
                            label?: string;
                            run_managers?: string[];
                            run_monitors?: string[];
                            tags?: string[];
                        };
                    };
                };
                responses: {
                    "200": {
                        content: { "application/json": { message: string } };
                        headers: { [name: string]: unknown };
                    };
                    "400": { content?: undefined; headers: { [name: string]: unknown } };
                    "403": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/flows/validate": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            definition: {
                                Comment?: string;
                                StartAt: string;
                                States: {
                                    [key: string]: | {
                                        Comment?: unknown;
                                        End?: unknown;
                                        InputPath?: unknown;
                                        Next?: unknown;
                                        Parameters?: unknown;
                                        ResultPath?: unknown;
                                        Type?: (...)
                                        | (...);
                                    } & { End?: (...)
                                    | (...)
                                    | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                        InputPath?: (...) | (...);
                                    } & { ResultPath?: (...)
                                    | (...) }
                                    | {
                                        ActionScope?: (...) | (...);
                                        ActionUrl: string;
                                        Catch?: unknown;
                                        Comment?: unknown;
                                        End?: unknown;
                                        ExceptionOnActionFailure: boolean;
                                        InputPath?: unknown;
                                        Next?: unknown;
                                        Parameters?: unknown;
                                        ResultPath?: unknown;
                                        RunAs?: (...) | (...);
                                        Type: string;
                                        WaitTime?: (...) | (...);
                                    } & { End?: (...)
                                    | (...)
                                    | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                        InputPath?: (...) | (...);
                                    } & { ResultPath?: (...)
                                    | (...) } & { Catch?: (...) | (...) }
                                    | {
                                        Comment?: unknown;
                                        Next?: string;
                                        Seconds?: number;
                                        SecondsPath?: string;
                                        Timestamp?: string;
                                        TimestampPath?: string;
                                        Type?: string;
                                    }
                                    | {
                                        Choices: ((...) & (...))[];
                                        Comment?: string;
                                        Default?: string;
                                        Type?: string;
                                    }
                                    | {
                                        Comment?: unknown;
                                        Next: string;
                                        Parameters: unknown;
                                        ResultPath: unknown;
                                        Type?: (...)
                                        | (...);
                                    } & { Parameters?: (...)
                                    | (...) } & { ResultPath?: (...) | (...) }
                                    | {
                                        Cause?: string;
                                        Comment?: string;
                                        Error?: string;
                                        Type?: string;
                                    };
                                };
                            };
                            input_schema?: Record<string, never>;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": { scopes?: { [key: string]: string[] } };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": { content?: undefined; headers: { [name: string]: unknown } };
                    "403": { content?: undefined; headers: { [name: string]: unknown } };
                    "409": { content?: undefined; headers: { [name: string]: unknown } };
                    "422": {
                        content: {
                            "application/json": {
                                debug_id: string;
                                error: {
                                    code: string;
                                    detail: string | { loc: (...)[]; msg: string; type: string }[];
                                    message?: string;
                                };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/mine": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: {
                        roles?: (
                            | "flow_owner"
                            | "flow_viewers"
                            | "flow_starters"
                            | "flow_administrators"
                        )[];
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                flows?: {
                                    api_version?: "1.0";
                                    created_at?: string;
                                    definition?: { Comment?: ...; StartAt: ...; States: ... };
                                    description?: string;
                                    flow_administrators?: (...)[];
                                    flow_owner?: string;
                                    flow_starters?: (...)[];
                                    flow_url?: string;
                                    flow_viewers?: (...)[];
                                    globus_auth_scope?: string;
                                    globus_auth_scopes_by_RunAs?: (...)[];
                                    globus_auth_username?: string;
                                    id?: string;
                                    input_schema?: Record<(...), (...)>;
                                    keywords?: (...)[];
                                    log_supported?: boolean;
                                    principal_urn?: string;
                                    subscription_id?: string;
                                    subtitle?: string;
                                    synchronous?: boolean;
                                    title?: string;
                                    types?: (...)[];
                                    updated_at?: string;
                                    user_role?:
                                        | "flow_owner"
                                        | "flow_viewer"
                                        | "flow_starter"
                                        | "flow_administrator";
                                }[];
                                has_next_page?: boolean;
                                limit?: number;
                                marker?: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": { content?: undefined; headers: { [name: string]: unknown } };
                    "403": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/runs": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: {
                        filter_completion_time?: string;
                        filter_flow_id?: string[];
                        filter_flow_title?: string[];
                        filter_label?: string[];
                        filter_role?: "run_manager"
                        | "run_monitor"
                        | "run_owner";
                        filter_roles?: (
                            | "run_managers"
                            | "run_monitors"
                            | "run_owner"
                            | "flow_run_managers"
                            | "flow_run_monitors"
                        )[];
                        filter_start_time?: string;
                        filter_status?: (
                            "SUCCEEDED"
                            | "FAILED"
                            | "ACTIVE"
                            | "INACTIVE"
                            | "ENDED"
                        )[];
                        marker?: string;
                        orderby?: string[];
                        page?: number;
                        pagination_token?: string;
                        per_page?: number;
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                actions?: {
                                    action_id: string;
                                    completion_time: string;
                                    details: Record<string, never>;
                                    display_status?: string;
                                    flow_id: string;
                                    flow_last_updated: string;
                                    label: string;
                                    run_id: string;
                                    run_managers?: (...)[];
                                    run_monitors?: (...)[];
                                    run_owner: string;
                                    start_time: string;
                                    status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED";
                                    tags: string[];
                                    user_role: "run_manager" | "run_monitor" | "run_owner";
                                }[];
                                has_next_page: boolean;
                                marker?: string;
                                runs?: {
                                    action_id: string;
                                    completion_time: string;
                                    details: Record<string, never>;
                                    display_status?: string;
                                    flow_id: string;
                                    flow_last_updated: string;
                                    label: string;
                                    run_id: string;
                                    run_managers?: (...)[];
                                    run_monitors?: (...)[];
                                    run_owner: string;
                                    start_time: string;
                                    status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED";
                                    tags: string[];
                                    user_role: "run_manager" | "run_monitor" | "run_owner";
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": { content?: undefined; headers: { [name: string]: unknown } };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/runs/{action_id}/log": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { flow_id: string; run_id: string };
                    query?: {
                        limit?: number;
                        pagination_token?: string;
                        reverse_order?: boolean;
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                entries: Record<string, never>[];
                                has_next_page: boolean;
                                limit: number;
                                marker?: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": { content?: undefined; headers: { [name: string]: unknown } };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string; run_id: string };
                query?: {
                    limit?: number;
                    pagination_token?: string;
                    reverse_order?: boolean;
                };
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/runs/{action_id}/resume": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string; run_id: string };
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { flow_id: string; run_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                action_id: string;
                                completion_time: string;
                                details: Record<string, never>;
                                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";
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/runs/{run_id}": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { run_id: string };
                    query?: { include_flow_description?: boolean };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                action_id: string;
                                completion_time: string;
                                details: Record<string, never>;
                                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_description?: {
                                    created_at: string;
                                    deleted_at?: string;
                                    description?: string;
                                    flow_owner?: string;
                                    id: string;
                                    keywords?: (...)[];
                                    subtitle?: string;
                                    title: string;
                                    updated_at?: string;
                                };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": { content?: undefined; headers: { [name: string]: unknown } };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { run_id: string };
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { run_id: string };
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            label?: string;
                            run_managers?: string[];
                            run_monitors?: string[];
                            tags?: string[];
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                action_id: string;
                                completion_time: string;
                                details: Record<string, never>;
                                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";
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": { content?: undefined; headers: { [name: string]: unknown } };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                    "422": { content?: undefined; headers: { [name: string]: unknown } };
                    "429": { content?: undefined; headers: { [name: string]: unknown } };
                    "502": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            trace?: undefined;
        };
        "/runs/{run_id}/cancel": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { run_id: string };
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { run_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "202": {
                        content: {
                            "application/json": {
                                action_id: string;
                                completion_time: string;
                                details: Record<string, never>;
                                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";
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                    "502": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/runs/{run_id}/definition": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { run_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                definition: Record<string, never>;
                                flow_id: string;
                                input_schema: Record<string, never>;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": { content?: undefined; headers: { [name: string]: unknown } };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { run_id: string };
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/runs/{run_id}/release": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { run_id: string };
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { run_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                action_id: string;
                                completion_time: string;
                                details: Record<string, never>;
                                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";
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": { content?: undefined; headers: { [name: string]: unknown } };
                    "404": { content?: undefined; headers: { [name: string]: unknown } };
                    "409": { content?: undefined; headers: { [name: string]: unknown } };
                    "429": { content?: undefined; headers: { [name: string]: unknown } };
                    "500": { content?: undefined; headers: { [name: string]: unknown } };
                    "502": { content?: undefined; headers: { [name: string]: unknown } };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
    }
    Index

    Properties

    "/batch/runs": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        add?: {
                            run_managers?: string[];
                            run_monitors?: string[];
                            tags?: string[];
                        };
                        filters: { run_ids: string[] };
                        remove?: {
                            run_managers?: string[];
                            run_monitors?: string[];
                            tags?: string[];
                        };
                        set?: {
                            run_managers?: string[];
                            run_monitors?: string[];
                            status?: "cancel";
                            tags?: string[];
                        };
                    };
                };
            };
            responses: never;
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      add?: {
                          run_managers?: string[];
                          run_monitors?: string[];
                          tags?: string[];
                      };
                      filters: { run_ids: string[] };
                      remove?: {
                          run_managers?: string[];
                          run_monitors?: string[];
                          tags?: string[];
                      };
                      set?: {
                          run_managers?: string[];
                          run_monitors?: string[];
                          status?: "cancel";
                          tags?: string[];
                      };
                  };
              };
          };
          responses: never;
      }

      Update metadata for multiple Runs.

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/flows": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    filter_description?: string[];
                    filter_fulltext?: string[];
                    filter_keywords?: string[];
                    filter_role?:
                        | "flow_owner"
                        | "flow_viewer"
                        | "flow_starter"
                        | "flow_administrator"
                        | "run_manager"
                        | "run_monitor";
                    filter_roles?: (
                        | "flow_owner"
                        | "flow_viewers"
                        | "flow_starters"
                        | "flow_administrators"
                        | "run_managers"
                        | "run_monitors"
                    )[];
                    filter_scope_string?: string[];
                    filter_subtitle?: string[];
                    filter_title?: string[];
                    marker?: string;
                    orderby?: string[];
                    page?: number;
                    per_page?: number;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            flows?: {
                                api_version?: "1.0";
                                created_at?: string;
                                definition?: { Comment?: ...; StartAt: ...; States: ... };
                                description?: string;
                                flow_administrators?: (...)[];
                                flow_owner?: string;
                                flow_starters?: (...)[];
                                flow_url?: string;
                                flow_viewers?: (...)[];
                                globus_auth_scope?: string;
                                globus_auth_scopes_by_RunAs?: (...)[];
                                globus_auth_username?: string;
                                id?: string;
                                input_schema?: Record<(...), (...)>;
                                keywords?: (...)[];
                                log_supported?: boolean;
                                principal_urn?: string;
                                subscription_id?: string;
                                subtitle?: string;
                                synchronous?: boolean;
                                title?: string;
                                types?: (...)[];
                                updated_at?: string;
                                user_role?:
                                    | "flow_owner"
                                    | "flow_viewer"
                                    | "flow_starter"
                                    | "flow_administrator";
                            }[];
                            has_next_page?: boolean;
                            limit?: number;
                            marker?: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": { content?: undefined; headers: { [name: string]: unknown } };
                "403": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        definition: {
                            Comment?: string;
                            StartAt: string;
                            States: {
                                [key: string]: | {
                                    Comment?: unknown;
                                    End?: unknown;
                                    InputPath?: unknown;
                                    Next?: unknown;
                                    Parameters?: unknown;
                                    ResultPath?: unknown;
                                    Type?: (...)
                                    | (...);
                                } & { End?: (...)
                                | (...)
                                | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                    InputPath?: (...) | (...);
                                } & { ResultPath?: (...)
                                | (...) }
                                | {
                                    ActionScope?: (...) | (...);
                                    ActionUrl: string;
                                    Catch?: unknown;
                                    Comment?: unknown;
                                    End?: unknown;
                                    ExceptionOnActionFailure: boolean;
                                    InputPath?: unknown;
                                    Next?: unknown;
                                    Parameters?: unknown;
                                    ResultPath?: unknown;
                                    RunAs?: (...) | (...);
                                    Type: string;
                                    WaitTime?: (...) | (...);
                                } & { End?: (...)
                                | (...)
                                | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                    InputPath?: (...) | (...);
                                } & { ResultPath?: (...)
                                | (...) } & { Catch?: (...) | (...) }
                                | {
                                    Comment?: unknown;
                                    Next?: string;
                                    Seconds?: number;
                                    SecondsPath?: string;
                                    Timestamp?: string;
                                    TimestampPath?: string;
                                    Type?: string;
                                }
                                | {
                                    Choices: ((...) & (...))[];
                                    Comment?: string;
                                    Default?: string;
                                    Type?: string;
                                }
                                | {
                                    Comment?: unknown;
                                    Next: string;
                                    Parameters: unknown;
                                    ResultPath: unknown;
                                    Type?: (...)
                                    | (...);
                                } & { Parameters?: (...)
                                | (...) } & { ResultPath?: (...) | (...) }
                                | { Cause?: string; Comment?: string; Error?: string; Type?: string };
                            };
                        };
                        description?: string;
                        flow_administrators?: string[];
                        flow_starters?: string[];
                        flow_viewers?: string[];
                        input_schema?: Record<string, never>;
                        keywords?: string[];
                        run_managers?: string[];
                        run_monitors?: string[];
                        subscription_id?: string;
                        subtitle?: string;
                        title?: string;
                    };
                };
            };
            responses: {
                "201": {
                    content: {
                        "application/json": {
                            api_version?: "1.0";
                            created_at?: string;
                            definition?: {
                                Comment?: string;
                                StartAt: string;
                                States: {
                                    [key: string]: | (...) & (...) & (...) & (...) & (...)
                                    | (...) & (...) & (...) & (...) & (...) & (...)
                                    | {
                                        Comment?: ...;
                                        Next?: ...;
                                        Seconds?: ...;
                                        SecondsPath?: ...;
                                        Timestamp?: ...;
                                        TimestampPath?: ...;
                                        Type?: ...;
                                    }
                                    | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                    | (...) & (...) & (...)
                                    | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                                };
                            };
                            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, never>;
                            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";
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": { content?: undefined; headers: { [name: string]: unknown } };
                "403": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: {
                  filter_description?: string[];
                  filter_fulltext?: string[];
                  filter_keywords?: string[];
                  filter_role?:
                      | "flow_owner"
                      | "flow_viewer"
                      | "flow_starter"
                      | "flow_administrator"
                      | "run_manager"
                      | "run_monitor";
                  filter_roles?: (
                      | "flow_owner"
                      | "flow_viewers"
                      | "flow_starters"
                      | "flow_administrators"
                      | "run_managers"
                      | "run_monitors"
                  )[];
                  filter_scope_string?: string[];
                  filter_subtitle?: string[];
                  filter_title?: string[];
                  marker?: string;
                  orderby?: string[];
                  page?: number;
                  per_page?: number;
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          flows?: {
                              api_version?: "1.0";
                              created_at?: string;
                              definition?: { Comment?: ...; StartAt: ...; States: ... };
                              description?: string;
                              flow_administrators?: (...)[];
                              flow_owner?: string;
                              flow_starters?: (...)[];
                              flow_url?: string;
                              flow_viewers?: (...)[];
                              globus_auth_scope?: string;
                              globus_auth_scopes_by_RunAs?: (...)[];
                              globus_auth_username?: string;
                              id?: string;
                              input_schema?: Record<(...), (...)>;
                              keywords?: (...)[];
                              log_supported?: boolean;
                              principal_urn?: string;
                              subscription_id?: string;
                              subtitle?: string;
                              synchronous?: boolean;
                              title?: string;
                              types?: (...)[];
                              updated_at?: string;
                              user_role?:
                                  | "flow_owner"
                                  | "flow_viewer"
                                  | "flow_starter"
                                  | "flow_administrator";
                          }[];
                          has_next_page?: boolean;
                          limit?: number;
                          marker?: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": { content?: undefined; headers: { [name: string]: unknown } };
              "403": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Retrieve all Flows

      Query the Flows service for a listing of Flows available to a user according to the permissions (role) they have on the Flow.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                filter_description?: string[];
                filter_fulltext?: string[];
                filter_keywords?: string[];
                filter_role?:
                    | "flow_owner"
                    | "flow_viewer"
                    | "flow_starter"
                    | "flow_administrator"
                    | "run_manager"
                    | "run_monitor";
                filter_roles?: (
                    | "flow_owner"
                    | "flow_viewers"
                    | "flow_starters"
                    | "flow_administrators"
                    | "run_managers"
                    | "run_monitors"
                )[];
                filter_scope_string?: string[];
                filter_subtitle?: string[];
                filter_title?: string[];
                marker?: string;
                orderby?: string[];
                page?: number;
                per_page?: number;
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • Optionalpath?: undefined
        • Optionalquery?: {
              filter_description?: string[];
              filter_fulltext?: string[];
              filter_keywords?: string[];
              filter_role?:
                  | "flow_owner"
                  | "flow_viewer"
                  | "flow_starter"
                  | "flow_administrator"
                  | "run_manager"
                  | "run_monitor";
              filter_roles?: (
                  | "flow_owner"
                  | "flow_viewers"
                  | "flow_starters"
                  | "flow_administrators"
                  | "run_managers"
                  | "run_monitors"
              )[];
              filter_scope_string?: string[];
              filter_subtitle?: string[];
              filter_title?: string[];
              marker?: string;
              orderby?: string[];
              page?: number;
              per_page?: number;
          }
          • Optionalfilter_description?: string[]

            Performs a case insensitive substring based search on the Flows' description field. If multiple values are specified, each Flow returned is guaranteed to contain at least one of the strings in its description.

            hello,science
            
          • Optionalfilter_fulltext?: string[]

            Given a one or more patterns, this filter searches against a pre-defined subset of fields for a match. If any of the fields match any of the patterns, the Flow is considered a match.

            The fields that are automatically searched in are:
              - title
              - subtitle
              - flow_owner
              - description
              - id
              - flow_administrators
            
            globus
            
          • Optionalfilter_keywords?: string[]

            Performs a case insensitive substring based search on the Flows' keywords field. If multiple values are specified, each Flow returned is guaranteed to contain at least one of the substrings as a keyword.

            hello,science
            
          • Optionalfilter_role?:
                | "flow_owner"
                | "flow_viewer"
                | "flow_starter"
                | "flow_administrator"
                | "run_manager"
                | "run_monitor"

            Return Flows for which the user has the provided role. The role the user has on the Flow dictates the operations they can perform. Roles are cumulative in the sense that having, for example, the "flow_starter" role also implies having the "flow_viewer" role. Thus, specifying "flow_starter" will also include all Flows for which the user has "flow_viewer" role as well. If not provided, only Flows for which the caller has "flow_owner" role will be returned.

            flow_starter
            
          • Optionalfilter_roles?: (
                | "flow_owner"
                | "flow_viewers"
                | "flow_starters"
                | "flow_administrators"
                | "run_managers"
                | "run_monitors"
            )[]

            Return Flows for which the user has the supplied role. The role the user has on the Flow dictates the operations they can perform. If multiple roles are specified, the user will have at least one of the specified roles on each Flow returned.

            flow_owner,flow_viewers
            
          • Optionalfilter_scope_string?: string[]

            Performs a case insensitive substring based search on the Flows' scope string fields. If multiple values are specified, each Flow returned is guaranteed to contain at least one of the strings in its scope strings.

            0abc,100
            
          • Optionalfilter_subtitle?: string[]

            Performs a case insensitive substring based search on the Flows' subtitle field. If multiple values are specified, each Flow returned is guaranteed to contain at least one of the strings in its subtitle.

            hello,science
            
          • Optionalfilter_title?: string[]

            Performs a case insensitive substring based search on the Flows' title field. If multiple values are specified, each Flow returned is guaranteed to contain at least one of the strings in its title.

            hello,science
            
          • Optionalmarker?: string

            An opaque token used to iterate through pages of returned Flows. If provided, all other query arguments will be ignored. The marker encodes all state in a given query, therefore it's unnecessary to provide query arguments once an initial marker has been received.

          • Optionalorderby?: string[]

            An ordering criteria to apply to the resulting Flows listing. The first value indicates the field to order on, and the second value indicates the sorting order. The first ordering criteria will be used to sort the data, subsequent ordering criteria will be applied for ties.

            Fields that support ordering are:
              - id
              - scope_string
              - flow_owner
              - flow_administrators
              - title
              - created_at
              - updated_at
            
            Supported orderings are:
              - ASC
              - DESC
            
            orderby=id ASC
            
            title ASC,id DESC
            
          • Optionalpage?: number

            The page of results to return.

            2
            
          • Optionalper_page?: number

            The number of results to return in a single paged response.

            50
            
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        flows?: {
                            api_version?: "1.0";
                            created_at?: string;
                            definition?: { Comment?: ...; StartAt: ...; States: ... };
                            description?: string;
                            flow_administrators?: (...)[];
                            flow_owner?: string;
                            flow_starters?: (...)[];
                            flow_url?: string;
                            flow_viewers?: (...)[];
                            globus_auth_scope?: string;
                            globus_auth_scopes_by_RunAs?: (...)[];
                            globus_auth_username?: string;
                            id?: string;
                            input_schema?: Record<(...), (...)>;
                            keywords?: (...)[];
                            log_supported?: boolean;
                            principal_urn?: string;
                            subscription_id?: string;
                            subtitle?: string;
                            synchronous?: boolean;
                            title?: string;
                            types?: (...)[];
                            updated_at?: string;
                            user_role?:
                                | "flow_owner"
                                | "flow_viewer"
                                | "flow_starter"
                                | "flow_administrator";
                        }[];
                        has_next_page?: boolean;
                        limit?: number;
                        marker?: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": { content?: undefined; headers: { [name: string]: unknown } };
            "403": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      flows?: {
                          api_version?: "1.0";
                          created_at?: string;
                          definition?: { Comment?: ...; StartAt: ...; States: ... };
                          description?: string;
                          flow_administrators?: (...)[];
                          flow_owner?: string;
                          flow_starters?: (...)[];
                          flow_url?: string;
                          flow_viewers?: (...)[];
                          globus_auth_scope?: string;
                          globus_auth_scopes_by_RunAs?: (...)[];
                          globus_auth_username?: string;
                          id?: string;
                          input_schema?: Record<(...), (...)>;
                          keywords?: (...)[];
                          log_supported?: boolean;
                          principal_urn?: string;
                          subscription_id?: string;
                          subtitle?: string;
                          synchronous?: boolean;
                          title?: string;
                          types?: (...)[];
                          updated_at?: string;
                          user_role?:
                              | "flow_owner"
                              | "flow_viewer"
                              | "flow_starter"
                              | "flow_administrator";
                      }[];
                      has_next_page?: boolean;
                      limit?: number;
                      marker?: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          The requestor has successfully authenticated and queried the Flow's service for the Flows available for them.

        • 400: { content?: undefined; headers: { [name: string]: unknown } }

          There was an issue parsing the query parameters.

        • 403: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor presented a token with insufficient scopes.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      definition: {
                          Comment?: string;
                          StartAt: string;
                          States: {
                              [key: string]: | {
                                  Comment?: unknown;
                                  End?: unknown;
                                  InputPath?: unknown;
                                  Next?: unknown;
                                  Parameters?: unknown;
                                  ResultPath?: unknown;
                                  Type?: (...)
                                  | (...);
                              } & { End?: (...)
                              | (...)
                              | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                  InputPath?: (...) | (...);
                              } & { ResultPath?: (...)
                              | (...) }
                              | {
                                  ActionScope?: (...) | (...);
                                  ActionUrl: string;
                                  Catch?: unknown;
                                  Comment?: unknown;
                                  End?: unknown;
                                  ExceptionOnActionFailure: boolean;
                                  InputPath?: unknown;
                                  Next?: unknown;
                                  Parameters?: unknown;
                                  ResultPath?: unknown;
                                  RunAs?: (...) | (...);
                                  Type: string;
                                  WaitTime?: (...) | (...);
                              } & { End?: (...)
                              | (...)
                              | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                  InputPath?: (...) | (...);
                              } & { ResultPath?: (...)
                              | (...) } & { Catch?: (...) | (...) }
                              | {
                                  Comment?: unknown;
                                  Next?: string;
                                  Seconds?: number;
                                  SecondsPath?: string;
                                  Timestamp?: string;
                                  TimestampPath?: string;
                                  Type?: string;
                              }
                              | {
                                  Choices: ((...) & (...))[];
                                  Comment?: string;
                                  Default?: string;
                                  Type?: string;
                              }
                              | {
                                  Comment?: unknown;
                                  Next: string;
                                  Parameters: unknown;
                                  ResultPath: unknown;
                                  Type?: (...)
                                  | (...);
                              } & { Parameters?: (...)
                              | (...) } & { ResultPath?: (...) | (...) }
                              | { Cause?: string; Comment?: string; Error?: string; Type?: string };
                          };
                      };
                      description?: string;
                      flow_administrators?: string[];
                      flow_starters?: string[];
                      flow_viewers?: string[];
                      input_schema?: Record<string, never>;
                      keywords?: string[];
                      run_managers?: string[];
                      run_monitors?: string[];
                      subscription_id?: string;
                      subtitle?: string;
                      title?: string;
                  };
              };
          };
          responses: {
              "201": {
                  content: {
                      "application/json": {
                          api_version?: "1.0";
                          created_at?: string;
                          definition?: {
                              Comment?: string;
                              StartAt: string;
                              States: {
                                  [key: string]: | (...) & (...) & (...) & (...) & (...)
                                  | (...) & (...) & (...) & (...) & (...) & (...)
                                  | {
                                      Comment?: ...;
                                      Next?: ...;
                                      Seconds?: ...;
                                      SecondsPath?: ...;
                                      Timestamp?: ...;
                                      TimestampPath?: ...;
                                      Type?: ...;
                                  }
                                  | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                  | (...) & (...) & (...)
                                  | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                              };
                          };
                          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, never>;
                          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";
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": { content?: undefined; headers: { [name: string]: unknown } };
              "403": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Deploy a Flow

      Deploy a Flow and its schema.

      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • requestBody: {
            content: {
                "application/json": {
                    definition: {
                        Comment?: string;
                        StartAt: string;
                        States: {
                            [key: string]:
                                | {
                                    Comment?: unknown;
                                    End?: unknown;
                                    InputPath?: unknown;
                                    Next?: unknown;
                                    Parameters?: unknown;
                                    ResultPath?: unknown;
                                    Type?: (...)
                                    | (...);
                                } & { End?: (...)
                                | (...)
                                | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                    InputPath?: (...) | (...);
                                } & { ResultPath?: (...)
                                | (...) }
                                | {
                                    ActionScope?: (...) | (...);
                                    ActionUrl: string;
                                    Catch?: unknown;
                                    Comment?: unknown;
                                    End?: unknown;
                                    ExceptionOnActionFailure: boolean;
                                    InputPath?: unknown;
                                    Next?: unknown;
                                    Parameters?: unknown;
                                    ResultPath?: unknown;
                                    RunAs?: (...) | (...);
                                    Type: string;
                                    WaitTime?: (...) | (...);
                                } & { End?: (...)
                                | (...)
                                | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                    InputPath?: (...) | (...);
                                } & { ResultPath?: (...)
                                | (...) } & { Catch?: (...) | (...) }
                                | {
                                    Comment?: unknown;
                                    Next?: string;
                                    Seconds?: number;
                                    SecondsPath?: string;
                                    Timestamp?: string;
                                    TimestampPath?: string;
                                    Type?: string;
                                }
                                | {
                                    Choices: ((...) & (...))[];
                                    Comment?: string;
                                    Default?: string;
                                    Type?: string;
                                }
                                | {
                                    Comment?: unknown;
                                    Next: string;
                                    Parameters: unknown;
                                    ResultPath: unknown;
                                    Type?: (...)
                                    | (...);
                                } & { Parameters?: (...)
                                | (...) } & { ResultPath?: (...) | (...) }
                                | { Cause?: string; Comment?: string; Error?: string; Type?: string };
                        };
                    };
                    description?: string;
                    flow_administrators?: string[];
                    flow_starters?: string[];
                    flow_viewers?: string[];
                    input_schema?: Record<string, never>;
                    keywords?: string[];
                    run_managers?: string[];
                    run_monitors?: string[];
                    subscription_id?: string;
                    subtitle?: string;
                    title?: string;
                };
            };
        }
      • responses: {
            "201": {
                content: {
                    "application/json": {
                        api_version?: "1.0";
                        created_at?: string;
                        definition?: {
                            Comment?: string;
                            StartAt: string;
                            States: {
                                [key: string]:
                                    | (...) & (...) & (...) & (...) & (...)
                                    | (...) & (...) & (...) & (...) & (...) & (...)
                                    | {
                                        Comment?: ...;
                                        Next?: ...;
                                        Seconds?: ...;
                                        SecondsPath?: ...;
                                        Timestamp?: ...;
                                        TimestampPath?: ...;
                                        Type?: ...;
                                    }
                                    | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                    | (...) & (...) & (...)
                                    | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                            };
                        };
                        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, never>;
                        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";
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": { content?: undefined; headers: { [name: string]: unknown } };
            "403": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 201: {
              content: {
                  "application/json": {
                      api_version?: "1.0";
                      created_at?: string;
                      definition?: {
                          Comment?: string;
                          StartAt: string;
                          States: {
                              [key: string]:
                                  | (...) & (...) & (...) & (...) & (...)
                                  | (...) & (...) & (...) & (...) & (...) & (...)
                                  | {
                                      Comment?: ...;
                                      Next?: ...;
                                      Seconds?: ...;
                                      SecondsPath?: ...;
                                      Timestamp?: ...;
                                      TimestampPath?: ...;
                                      Type?: ...;
                                  }
                                  | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                  | (...) & (...) & (...)
                                  | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                          };
                      };
                      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, never>;
                      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";
                  };
              };
              headers: { [name: string]: unknown };
          }

          The Flow definition was successfully deployed onto the Flows service.

        • 400: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor attempted to deploy a malformed Flow.

        • 403: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor is not authorized to deploy a Flow.

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/flows/{flow_id}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            api_version?: "1.0";
                            created_at?: string;
                            definition?: {
                                Comment?: string;
                                StartAt: string;
                                States: {
                                    [key: string]: | (...) & (...) & (...) & (...) & (...)
                                    | (...) & (...) & (...) & (...) & (...) & (...)
                                    | {
                                        Comment?: ...;
                                        Next?: ...;
                                        Seconds?: ...;
                                        SecondsPath?: ...;
                                        Timestamp?: ...;
                                        TimestampPath?: ...;
                                        Type?: ...;
                                    }
                                    | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                    | (...) & (...) & (...)
                                    | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                                };
                            };
                            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, never>;
                            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";
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": { content?: undefined; headers: { [name: string]: unknown } };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            api_version?: "1.0";
                            created_at?: string;
                            definition?: {
                                Comment?: string;
                                StartAt: string;
                                States: {
                                    [key: string]: | (...) & (...) & (...) & (...) & (...)
                                    | (...) & (...) & (...) & (...) & (...) & (...)
                                    | {
                                        Comment?: ...;
                                        Next?: ...;
                                        Seconds?: ...;
                                        SecondsPath?: ...;
                                        Timestamp?: ...;
                                        TimestampPath?: ...;
                                        Type?: ...;
                                    }
                                    | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                    | (...) & (...) & (...)
                                    | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                                };
                            };
                            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, never>;
                            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";
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": { content?: undefined; headers: { [name: string]: unknown } };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        definition?: {
                            Comment?: string;
                            StartAt: string;
                            States: {
                                [key: string]: | {
                                    Comment?: ...;
                                    End?: ...;
                                    InputPath?: ...;
                                    Next?: ...;
                                    Parameters?: ...;
                                    ResultPath?: ...;
                                    Type?: ...;
                                } & { End?: ...; Next?: ... } & { Parameters?: ... } & {
                                    InputPath?: ...;
                                } & { ResultPath?: ... }
                                | {
                                    ActionScope?: ...;
                                    ActionUrl: ...;
                                    Catch?: ...;
                                    Comment?: ...;
                                    End?: ...;
                                    ExceptionOnActionFailure: ...;
                                    InputPath?: ...;
                                    Next?: ...;
                                    Parameters?: ...;
                                    ResultPath?: ...;
                                    RunAs?: ...;
                                    Type: ...;
                                    WaitTime?: ...;
                                } & { End?: ...; Next?: ... } & { Parameters?: ... } & {
                                    InputPath?: ...;
                                } & { ResultPath?: ... } & { Catch?: ... }
                                | {
                                    Comment?: unknown;
                                    Next?: (...) | (...);
                                    Seconds?: (...) | (...);
                                    SecondsPath?: (...) | (...);
                                    Timestamp?: (...) | (...);
                                    TimestampPath?: (...) | (...);
                                    Type?: (...) | (...);
                                }
                                | {
                                    Choices: (...)[];
                                    Comment?: (...) | (...);
                                    Default?: (...) | (...);
                                    Type?: (...) | (...);
                                }
                                | {
                                    Comment?: ...;
                                    Next: ...;
                                    Parameters: ...;
                                    ResultPath: ...;
                                    Type?: ...;
                                } & { Parameters?: ... } & { ResultPath?: ... }
                                | {
                                    Cause?: (...) | (...);
                                    Comment?: (...) | (...);
                                    Error?: (...) | (...);
                                    Type?: (...) | (...);
                                };
                            };
                        };
                        description?: string;
                        flow_administrators?: Record<string, never>[];
                        flow_owner?: string;
                        flow_starters?: Record<string, never>[];
                        flow_viewers?: Record<string, never>[];
                        input_schema?: Record<string, never>;
                        keywords?: Record<string, never>[];
                        run_managers?: string[];
                        run_monitors?: string[];
                        subscription_id?: string;
                        subtitle?: string;
                        title?: string;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            api_version?: "1.0";
                            created_at?: string;
                            definition?: {
                                Comment?: string;
                                StartAt: string;
                                States: {
                                    [key: string]: | (...) & (...) & (...) & (...) & (...)
                                    | (...) & (...) & (...) & (...) & (...) & (...)
                                    | {
                                        Comment?: ...;
                                        Next?: ...;
                                        Seconds?: ...;
                                        SecondsPath?: ...;
                                        Timestamp?: ...;
                                        TimestampPath?: ...;
                                        Type?: ...;
                                    }
                                    | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                    | (...) & (...) & (...)
                                    | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                                };
                            };
                            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, never>;
                            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";
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": { content?: undefined; headers: { [name: string]: unknown } };
                "403": { content?: undefined; headers: { [name: string]: unknown } };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        trace?: undefined;
    }

    Type declaration

    • delete: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { flow_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          api_version?: "1.0";
                          created_at?: string;
                          definition?: {
                              Comment?: string;
                              StartAt: string;
                              States: {
                                  [key: string]: | (...) & (...) & (...) & (...) & (...)
                                  | (...) & (...) & (...) & (...) & (...) & (...)
                                  | {
                                      Comment?: ...;
                                      Next?: ...;
                                      Seconds?: ...;
                                      SecondsPath?: ...;
                                      Timestamp?: ...;
                                      TimestampPath?: ...;
                                      Type?: ...;
                                  }
                                  | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                  | (...) & (...) & (...)
                                  | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                              };
                          };
                          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, never>;
                          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";
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": { content?: undefined; headers: { [name: string]: unknown } };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Remove a Flow

      Remove a Flow from the Flow service.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { flow_id: string }
          • flow_id: string

            The ID for the Flow whose definition is being looked up.

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        api_version?: "1.0";
                        created_at?: string;
                        definition?: {
                            Comment?: string;
                            StartAt: string;
                            States: {
                                [key: string]:
                                    | (...) & (...) & (...) & (...) & (...)
                                    | (...) & (...) & (...) & (...) & (...) & (...)
                                    | {
                                        Comment?: ...;
                                        Next?: ...;
                                        Seconds?: ...;
                                        SecondsPath?: ...;
                                        Timestamp?: ...;
                                        TimestampPath?: ...;
                                        Type?: ...;
                                    }
                                    | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                    | (...) & (...) & (...)
                                    | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                            };
                        };
                        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, never>;
                        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";
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": { content?: undefined; headers: { [name: string]: unknown } };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      api_version?: "1.0";
                      created_at?: string;
                      definition?: {
                          Comment?: string;
                          StartAt: string;
                          States: {
                              [key: string]:
                                  | (...) & (...) & (...) & (...) & (...)
                                  | (...) & (...) & (...) & (...) & (...) & (...)
                                  | {
                                      Comment?: ...;
                                      Next?: ...;
                                      Seconds?: ...;
                                      SecondsPath?: ...;
                                      Timestamp?: ...;
                                      TimestampPath?: ...;
                                      Type?: ...;
                                  }
                                  | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                  | (...) & (...) & (...)
                                  | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                          };
                      };
                      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, never>;
                      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";
                  };
              };
              headers: { [name: string]: unknown };
          }

          The requestor has successfully removed the Flow from the Flows service.

        • 403: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor attempted to modify a Flow for which they did not have access.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor attempted to remove a non-existent Flow, or the requestor did not have permissions to remove the Flow.

    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { flow_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          api_version?: "1.0";
                          created_at?: string;
                          definition?: {
                              Comment?: string;
                              StartAt: string;
                              States: {
                                  [key: string]: | (...) & (...) & (...) & (...) & (...)
                                  | (...) & (...) & (...) & (...) & (...) & (...)
                                  | {
                                      Comment?: ...;
                                      Next?: ...;
                                      Seconds?: ...;
                                      SecondsPath?: ...;
                                      Timestamp?: ...;
                                      TimestampPath?: ...;
                                      Type?: ...;
                                  }
                                  | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                  | (...) & (...) & (...)
                                  | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                              };
                          };
                          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, never>;
                          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";
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": { content?: undefined; headers: { [name: string]: unknown } };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Retrieve a Flow

      Get a previously deployed Flow.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { flow_id: string }
          • flow_id: string

            The ID for the Flow whose definition is being looked up.

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        api_version?: "1.0";
                        created_at?: string;
                        definition?: {
                            Comment?: string;
                            StartAt: string;
                            States: {
                                [key: string]:
                                    | (...) & (...) & (...) & (...) & (...)
                                    | (...) & (...) & (...) & (...) & (...) & (...)
                                    | {
                                        Comment?: ...;
                                        Next?: ...;
                                        Seconds?: ...;
                                        SecondsPath?: ...;
                                        Timestamp?: ...;
                                        TimestampPath?: ...;
                                        Type?: ...;
                                    }
                                    | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                    | (...) & (...) & (...)
                                    | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                            };
                        };
                        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, never>;
                        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";
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": { content?: undefined; headers: { [name: string]: unknown } };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      api_version?: "1.0";
                      created_at?: string;
                      definition?: {
                          Comment?: string;
                          StartAt: string;
                          States: {
                              [key: string]:
                                  | (...) & (...) & (...) & (...) & (...)
                                  | (...) & (...) & (...) & (...) & (...) & (...)
                                  | {
                                      Comment?: ...;
                                      Next?: ...;
                                      Seconds?: ...;
                                      SecondsPath?: ...;
                                      Timestamp?: ...;
                                      TimestampPath?: ...;
                                      Type?: ...;
                                  }
                                  | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                  | (...) & (...) & (...)
                                  | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                          };
                      };
                      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, never>;
                      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";
                  };
              };
              headers: { [name: string]: unknown };
          }

          The requestor has successfully authenticated and queried the Flow's service for a specific Flow definition.

        • 403: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor attempted to retrieve a Flow definition for which they did not have access.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor attempted to retrieve a non-existent Flow, or the requestor did not have permissions to view a Flow.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { flow_id: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { flow_id: string }
        • flow_id: string

          The ID for the Flow whose definition is being looked up.

      • Optionalquery?: undefined
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • put: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { flow_id: string };
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      definition?: {
                          Comment?: string;
                          StartAt: string;
                          States: {
                              [key: string]: | {
                                  Comment?: ...;
                                  End?: ...;
                                  InputPath?: ...;
                                  Next?: ...;
                                  Parameters?: ...;
                                  ResultPath?: ...;
                                  Type?: ...;
                              } & { End?: ...; Next?: ... } & { Parameters?: ... } & {
                                  InputPath?: ...;
                              } & { ResultPath?: ... }
                              | {
                                  ActionScope?: ...;
                                  ActionUrl: ...;
                                  Catch?: ...;
                                  Comment?: ...;
                                  End?: ...;
                                  ExceptionOnActionFailure: ...;
                                  InputPath?: ...;
                                  Next?: ...;
                                  Parameters?: ...;
                                  ResultPath?: ...;
                                  RunAs?: ...;
                                  Type: ...;
                                  WaitTime?: ...;
                              } & { End?: ...; Next?: ... } & { Parameters?: ... } & {
                                  InputPath?: ...;
                              } & { ResultPath?: ... } & { Catch?: ... }
                              | {
                                  Comment?: unknown;
                                  Next?: (...) | (...);
                                  Seconds?: (...) | (...);
                                  SecondsPath?: (...) | (...);
                                  Timestamp?: (...) | (...);
                                  TimestampPath?: (...) | (...);
                                  Type?: (...) | (...);
                              }
                              | {
                                  Choices: (...)[];
                                  Comment?: (...) | (...);
                                  Default?: (...) | (...);
                                  Type?: (...) | (...);
                              }
                              | {
                                  Comment?: ...;
                                  Next: ...;
                                  Parameters: ...;
                                  ResultPath: ...;
                                  Type?: ...;
                              } & { Parameters?: ... } & { ResultPath?: ... }
                              | {
                                  Cause?: (...) | (...);
                                  Comment?: (...) | (...);
                                  Error?: (...) | (...);
                                  Type?: (...) | (...);
                              };
                          };
                      };
                      description?: string;
                      flow_administrators?: Record<string, never>[];
                      flow_owner?: string;
                      flow_starters?: Record<string, never>[];
                      flow_viewers?: Record<string, never>[];
                      input_schema?: Record<string, never>;
                      keywords?: Record<string, never>[];
                      run_managers?: string[];
                      run_monitors?: string[];
                      subscription_id?: string;
                      subtitle?: string;
                      title?: string;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          api_version?: "1.0";
                          created_at?: string;
                          definition?: {
                              Comment?: string;
                              StartAt: string;
                              States: {
                                  [key: string]: | (...) & (...) & (...) & (...) & (...)
                                  | (...) & (...) & (...) & (...) & (...) & (...)
                                  | {
                                      Comment?: ...;
                                      Next?: ...;
                                      Seconds?: ...;
                                      SecondsPath?: ...;
                                      Timestamp?: ...;
                                      TimestampPath?: ...;
                                      Type?: ...;
                                  }
                                  | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                  | (...) & (...) & (...)
                                  | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                              };
                          };
                          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, never>;
                          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";
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": { content?: undefined; headers: { [name: string]: unknown } };
              "403": { content?: undefined; headers: { [name: string]: unknown } };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Update a Flow

      Update a previously deployed Flow.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { flow_id: string }
          • flow_id: string

            The ID for the Flow whose definition is being looked up.

        • Optionalquery?: undefined
      • requestBody: {
            content: {
                "application/json": {
                    definition?: {
                        Comment?: string;
                        StartAt: string;
                        States: {
                            [key: string]:
                                | {
                                    Comment?: ...;
                                    End?: ...;
                                    InputPath?: ...;
                                    Next?: ...;
                                    Parameters?: ...;
                                    ResultPath?: ...;
                                    Type?: ...;
                                } & { End?: ...; Next?: ... } & { Parameters?: ... } & {
                                    InputPath?: ...;
                                } & { ResultPath?: ... }
                                | {
                                    ActionScope?: ...;
                                    ActionUrl: ...;
                                    Catch?: ...;
                                    Comment?: ...;
                                    End?: ...;
                                    ExceptionOnActionFailure: ...;
                                    InputPath?: ...;
                                    Next?: ...;
                                    Parameters?: ...;
                                    ResultPath?: ...;
                                    RunAs?: ...;
                                    Type: ...;
                                    WaitTime?: ...;
                                } & { End?: ...; Next?: ... } & { Parameters?: ... } & {
                                    InputPath?: ...;
                                } & { ResultPath?: ... } & { Catch?: ... }
                                | {
                                    Comment?: unknown;
                                    Next?: (...) | (...);
                                    Seconds?: (...) | (...);
                                    SecondsPath?: (...) | (...);
                                    Timestamp?: (...) | (...);
                                    TimestampPath?: (...) | (...);
                                    Type?: (...) | (...);
                                }
                                | {
                                    Choices: (...)[];
                                    Comment?: (...) | (...);
                                    Default?: (...) | (...);
                                    Type?: (...) | (...);
                                }
                                | {
                                    Comment?: ...;
                                    Next: ...;
                                    Parameters: ...;
                                    ResultPath: ...;
                                    Type?: ...;
                                } & { Parameters?: ... } & { ResultPath?: ... }
                                | {
                                    Cause?: (...) | (...);
                                    Comment?: (...) | (...);
                                    Error?: (...) | (...);
                                    Type?: (...) | (...);
                                };
                        };
                    };
                    description?: string;
                    flow_administrators?: Record<string, never>[];
                    flow_owner?: string;
                    flow_starters?: Record<string, never>[];
                    flow_viewers?: Record<string, never>[];
                    input_schema?: Record<string, never>;
                    keywords?: Record<string, never>[];
                    run_managers?: string[];
                    run_monitors?: string[];
                    subscription_id?: string;
                    subtitle?: string;
                    title?: string;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        api_version?: "1.0";
                        created_at?: string;
                        definition?: {
                            Comment?: string;
                            StartAt: string;
                            States: {
                                [key: string]:
                                    | (...) & (...) & (...) & (...) & (...)
                                    | (...) & (...) & (...) & (...) & (...) & (...)
                                    | {
                                        Comment?: ...;
                                        Next?: ...;
                                        Seconds?: ...;
                                        SecondsPath?: ...;
                                        Timestamp?: ...;
                                        TimestampPath?: ...;
                                        Type?: ...;
                                    }
                                    | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                    | (...) & (...) & (...)
                                    | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                            };
                        };
                        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, never>;
                        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";
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": { content?: undefined; headers: { [name: string]: unknown } };
            "403": { content?: undefined; headers: { [name: string]: unknown } };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      api_version?: "1.0";
                      created_at?: string;
                      definition?: {
                          Comment?: string;
                          StartAt: string;
                          States: {
                              [key: string]:
                                  | (...) & (...) & (...) & (...) & (...)
                                  | (...) & (...) & (...) & (...) & (...) & (...)
                                  | {
                                      Comment?: ...;
                                      Next?: ...;
                                      Seconds?: ...;
                                      SecondsPath?: ...;
                                      Timestamp?: ...;
                                      TimestampPath?: ...;
                                      Type?: ...;
                                  }
                                  | { Choices: ...; Comment?: ...; Default?: ...; Type?: ... }
                                  | (...) & (...) & (...)
                                  | { Cause?: ...; Comment?: ...; Error?: ...; Type?: ... };
                          };
                      };
                      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, never>;
                      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";
                  };
              };
              headers: { [name: string]: unknown };
          }

          The requestor has successfully authenticated and updated the target Flow definition.

        • 400: { content?: undefined; headers: { [name: string]: unknown } }

          The Flow definition update failed due to an attempt to perform a malformed update.

        • 403: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor attempted to update a Flow for which they did not have access.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor attempted to update a non-existent Flow, or the requestor did not have permissions to update a Flow.

    • Optionaltrace?: undefined
    "/flows/{flow_id}/{run_id}/log": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string; run_id: string };
                query?: {
                    limit?: number;
                    pagination_token?: string;
                    reverse_order?: boolean;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            entries: Record<string, never>[];
                            has_next_page: boolean;
                            limit: number;
                            marker?: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": { content?: undefined; headers: { [name: string]: unknown } };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string; run_id: string };
            query?: {
                limit?: number;
                pagination_token?: string;
                reverse_order?: boolean;
            };
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { flow_id: string; run_id: string };
              query?: {
                  limit?: number;
                  pagination_token?: string;
                  reverse_order?: boolean;
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          entries: Record<string, never>[];
                          has_next_page: boolean;
                          limit: number;
                          marker?: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": { content?: undefined; headers: { [name: string]: unknown } };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Get execution details on a Run

      Retrieve detailed execution information for a particular Flow Run

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string; run_id: string };
            query?: {
                limit?: number;
                pagination_token?: string;
                reverse_order?: boolean;
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { flow_id: string; run_id: string }
          • flow_id: string

            The ID for the Flow which launched the Run.

          • run_id: string

            The ID for the Run whose log is getting pulled.

        • Optionalquery?: { limit?: number; pagination_token?: string; reverse_order?: boolean }
          • Optionallimit?: number

            An integer limit on the number of log records returned.

          • Optionalpagination_token?: string

            A token used to iterate through pages of returned log records.

          • Optionalreverse_order?: boolean

            A flag to indicate if log records should be returned in reverse order.

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        entries: Record<string, never>[];
                        has_next_page: boolean;
                        limit: number;
                        marker?: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": { content?: undefined; headers: { [name: string]: unknown } };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      entries: Record<string, never>[];
                      has_next_page: boolean;
                      limit: number;
                      marker?: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          The request was successfully received.

        • 400: { content?: undefined; headers: { [name: string]: unknown } }

          There was an issue parsing the query parameters.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The requested Action or Flow was not found. Or, the requestor did not have access to view the Action.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { flow_id: string; run_id: string };
          query?: {
              limit?: number;
              pagination_token?: string;
              reverse_order?: boolean;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { flow_id: string; run_id: string }
        • flow_id: string

          The ID for the Flow which launched the Run.

        • run_id: string

          The ID for the Run whose log is getting pulled.

      • Optionalquery?: { limit?: number; pagination_token?: string; reverse_order?: boolean }
        • Optionallimit?: number

          An integer limit on the number of log records returned.

        • Optionalpagination_token?: string

          A token used to iterate through pages of returned log records.

        • Optionalreverse_order?: boolean

          A flag to indicate if log records should be returned in reverse order.

    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/flows/{flow_id}/{run_id}/resume": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string; run_id: string };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string; run_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            action_id: string;
                            completion_time: string;
                            details: Record<string, never>;
                            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";
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { flow_id: string; run_id: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { flow_id: string; run_id: string }
        • flow_id: string

          The ID for the Flow which launched the Run.

        • run_id: string

          The ID for the Run whose data is being resumed.

      • Optionalquery?: undefined
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { flow_id: string; run_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          action_id: string;
                          completion_time: string;
                          details: Record<string, never>;
                          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";
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Resume a Run

      Attempt to resume a Run, particularly when it has reached a status of INACTIVE. A Flow Run may reach an INACTIVE status when an Action type state within the Flow returns its status as INACTIVE. The resume operation on the Flow Run provides a hint that the cause of the Action becoming INACTIVE may have been cleared, and thus the resume operation on the Action Provider should be invoked to allow the Action state to resume and thus resume the Flow Run.

      In the particular case that an Action state is INACTIVE with a
      code value of "ConsentRequired" it is further assumed that the
      Bearer token provided in the Authorization header on the
      resume operation now carries sufficient consents to continue
      the INACTIVE Action. Thus, the Flow service will use the
      Bearer token to generate new dependent tokens for running the
      Action and use these tokens to request that the Action be
      resumed at the Action Provider.
      
      Note again that in reasons other than "ConsentRequired" for a
      Flow or Action to go INACTIVE, the resume operation is just a
      hint. For example, when the code is "ActivationRequired,"
      indicating that a Globus collection or endpoint needs to be
      Activated by the user, performing that Activation out-of-band
      from the Flow will allow the Flow to proceed even without the
      resume operation as the Action is periodically polled for
      progress. Performing the resume operation may simply cause a
      poll to happen more quickly and thus allow the Action to
      resume more quickly.
      
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string; run_id: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { flow_id: string; run_id: string }
          • flow_id: string

            The ID for the Flow which launched the Run.

          • run_id: string

            The ID for the Run whose data is being resumed.

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        action_id: string;
                        completion_time: string;
                        details: Record<string, never>;
                        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";
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      action_id: string;
                      completion_time: string;
                      details: Record<string, never>;
                      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";
                  };
              };
              headers: { [name: string]: unknown };
          }

          The request was successful.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The requested Run or Flow was not found. Or, the requestor did not have access to manage the Run.

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/flows/{flow_id}/actions": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string };
                query?: {
                    filter_completion_time?: string;
                    filter_label?: string[];
                    filter_role?:
                        | "run_manager"
                        | "run_monitor"
                        | "run_owner"
                        | "flow_run_manager"
                        | "flow_run_monitor";
                    filter_roles?: (
                        | "run_manager"
                        | "run_monitor"
                        | "run_owner"
                        | "flow_run_manager"
                        | "flow_run_monitor"
                    )[];
                    filter_start_time?: string;
                    filter_status?: (
                        "SUCCEEDED"
                        | "FAILED"
                        | "ACTIVE"
                        | "INACTIVE"
                        | "ENDED"
                    )[];
                    marker?: string;
                    orderby?: string[];
                    page?: number;
                    pagination_token?: string;
                    per_page?: number;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            actions: {
                                action_id: string;
                                completion_time: string;
                                details: Record<string, never>;
                                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";
                            }[];
                            has_next_page: boolean;
                            marker?: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": { content?: undefined; headers: { [name: string]: unknown } };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { flow_id: string };
              query?: {
                  filter_completion_time?: string;
                  filter_label?: string[];
                  filter_role?:
                      | "run_manager"
                      | "run_monitor"
                      | "run_owner"
                      | "flow_run_manager"
                      | "flow_run_monitor";
                  filter_roles?: (
                      | "run_manager"
                      | "run_monitor"
                      | "run_owner"
                      | "flow_run_manager"
                      | "flow_run_monitor"
                  )[];
                  filter_start_time?: string;
                  filter_status?: (
                      "SUCCEEDED"
                      | "FAILED"
                      | "ACTIVE"
                      | "INACTIVE"
                      | "ENDED"
                  )[];
                  marker?: string;
                  orderby?: string[];
                  page?: number;
                  pagination_token?: string;
                  per_page?: number;
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          actions: {
                              action_id: string;
                              completion_time: string;
                              details: Record<string, never>;
                              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";
                          }[];
                          has_next_page: boolean;
                          marker?: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": { content?: undefined; headers: { [name: string]: unknown } };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Get a Flow's Runs

      Retrieve a listing of Runs launched from a particular Flow. If hitting the */actions endpoint, the response will list the Runs under a "actions" key. If hitting the */runs endpoint, the response will list the Runs under a "runs" key.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string };
            query?: {
                filter_completion_time?: string;
                filter_label?: string[];
                filter_role?:
                    | "run_manager"
                    | "run_monitor"
                    | "run_owner"
                    | "flow_run_manager"
                    | "flow_run_monitor";
                filter_roles?: (
                    | "run_manager"
                    | "run_monitor"
                    | "run_owner"
                    | "flow_run_manager"
                    | "flow_run_monitor"
                )[];
                filter_start_time?: string;
                filter_status?: ("SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED")[];
                marker?: string;
                orderby?: string[];
                page?: number;
                pagination_token?: string;
                per_page?: number;
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { flow_id: string }
          • flow_id: string

            The ID for the Flow which launched the Runs.

        • Optionalquery?: {
              filter_completion_time?: string;
              filter_label?: string[];
              filter_role?:
                  | "run_manager"
                  | "run_monitor"
                  | "run_owner"
                  | "flow_run_manager"
                  | "flow_run_monitor";
              filter_roles?: (
                  | "run_manager"
                  | "run_monitor"
                  | "run_owner"
                  | "flow_run_manager"
                  | "flow_run_monitor"
              )[];
              filter_start_time?: string;
              filter_status?: ("SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED")[];
              marker?: string;
              orderby?: string[];
              page?: number;
              pagination_token?: string;
              per_page?: number;
          }
          • Optionalfilter_completion_time?: string

            Given a pair of comma separated ISO 8601 date/time strings, filter results to only those Actions whose completion time is within the specified range. If one of the dates is omitted, it forms an open range, so "dt," returns all records with date greater or equal to dt, and ",dt" returns all records with dates less than dt. If there is no comma, it is treated in the same way as "dt,". Results will contain Actions which completed between the first date/time string onwards, up to (but not including) the second date/time string. Note that Actions which are still running will have null completion times and thus cannot be filtered by this field.

            2021-03-09T21:52:14,2021-03-09T21:53
            
          • Optionalfilter_label?: string[]

            Performs a case insensitive string based search on the Actions' label fields. If multiple values are specified, each Action returned is guaranteed to contain at least one of the strings in its label.

            science,tests
            
          • Optionalfilter_role?:
                | "run_manager"
                | "run_monitor"
                | "run_owner"
                | "flow_run_manager"
                | "flow_run_monitor"

            Return Actions for which the user has the provided role. The role the user has on the Action dictates the operations they can perform. Roles are cumulative in the sense that having, for example, the "run_manager" role also implies having the "run_monitor" role. Thus, specifying manager will also include all Actions for which the user has "run_monitor" role as well. If not provided, only Actions for which the caller has "run_owner" role will be returned.

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

            Return Actions for which the user has the supplied role. The role the user has on the Action dictates the operations they can perform. If multiple roles are specified, the user will have at least one of the specified roles on each Action returned.

            run_manager
            
          • Optionalfilter_start_time?: string

            Given a pair of comma separated ISO 8601 date/time strings, filter results to only those Actions which started running within the specified range. If one of the dates is omitted, it forms an open range, so "dt," returns all records with date greater or equal to dt, and ",dt" returns all records with dates less than dt. If there is no comma, it is treated in the same way as "dt,". Results will contain Actions which began between the first date/time string onwards, up to (but not including) the second date/time string.

            2021-03-09T21:52:14,2021-03-09T21:53
            
          • Optionalfilter_status?: ("SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED")[]

            Return Actions which are in the specified state. The state of the Action dictates the operations which can performed on them. If multiple statuses are specified, each Action returned will be in one of the specified states. By default, Actions in any state will be returned.

            FAILED,INACTIVE
            
          • Optionalmarker?: string

            An opaque token used to iterate through pages of returned Actions. If provided, all other query arguments will be ignored. The marker encodes all state in a given query, therefore it's unnecessary to provide query arguments once an initial marker has been received.

          • Optionalorderby?: string[]

            An ordering criteria to apply to the resulting Action listing. The first value indicates the field to order on, and the second value indicates the sorting order. The first ordering criteria will be used to sort the data, subsequent ordering criteria will be applied for ties.

            Fields that support ordering are:
              - id
              - start_time
              - completion_time
              - status
              - label
            
            Supported orderings are:
              - ASC
              - DESC
            
            orderby=id ASC
            
            start_time ASC,id DESC
            
          • Optionalpage?: number

            The page of results to return.

            2
            
          • Optionalpagination_token?: string

            ("marker" is now the preferred name for this parameter.) An opaque token used to iterate through pages of returned Actions. If provided, all other query arguments will be ignored. The pagination_token encodes all state in a given query, therefore it's unnecessary to provide query arguments once an initial token has been received.

          • Optionalper_page?: number

            The number of results to return in a single paged response.

            50
            
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        actions: {
                            action_id: string;
                            completion_time: string;
                            details: Record<string, never>;
                            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";
                        }[];
                        has_next_page: boolean;
                        marker?: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": { content?: undefined; headers: { [name: string]: unknown } };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      actions: {
                          action_id: string;
                          completion_time: string;
                          details: Record<string, never>;
                          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";
                      }[];
                      has_next_page: boolean;
                      marker?: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          The request was successfully received.

        • 403: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor presented a token with insufficient scopes.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The Flow does not exist or the requestor did not have access to enumerate the Flow's Actions.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { flow_id: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { flow_id: string }
        • flow_id: string

          The ID for the Flow which launched the Runs.

      • Optionalquery?: undefined
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/flows/{flow_id}/actions/{action_id}/log": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string; run_id: string };
                query?: {
                    limit?: number;
                    pagination_token?: string;
                    reverse_order?: boolean;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            entries: Record<string, never>[];
                            has_next_page: boolean;
                            limit: number;
                            marker?: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": { content?: undefined; headers: { [name: string]: unknown } };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string; run_id: string };
            query?: {
                limit?: number;
                pagination_token?: string;
                reverse_order?: boolean;
            };
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { flow_id: string; run_id: string };
              query?: {
                  limit?: number;
                  pagination_token?: string;
                  reverse_order?: boolean;
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          entries: Record<string, never>[];
                          has_next_page: boolean;
                          limit: number;
                          marker?: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": { content?: undefined; headers: { [name: string]: unknown } };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Get execution details on a Run

      Retrieve detailed execution information for a particular Flow Run

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string; run_id: string };
            query?: {
                limit?: number;
                pagination_token?: string;
                reverse_order?: boolean;
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { flow_id: string; run_id: string }
          • flow_id: string

            The ID for the Flow which launched the Run.

          • run_id: string

            The ID for the Run whose log is getting pulled.

        • Optionalquery?: { limit?: number; pagination_token?: string; reverse_order?: boolean }
          • Optionallimit?: number

            An integer limit on the number of log records returned.

          • Optionalpagination_token?: string

            A token used to iterate through pages of returned log records.

          • Optionalreverse_order?: boolean

            A flag to indicate if log records should be returned in reverse order.

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        entries: Record<string, never>[];
                        has_next_page: boolean;
                        limit: number;
                        marker?: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": { content?: undefined; headers: { [name: string]: unknown } };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      entries: Record<string, never>[];
                      has_next_page: boolean;
                      limit: number;
                      marker?: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          The request was successfully received.

        • 400: { content?: undefined; headers: { [name: string]: unknown } }

          There was an issue parsing the query parameters.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The requested Action or Flow was not found. Or, the requestor did not have access to view the Action.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { flow_id: string; run_id: string };
          query?: {
              limit?: number;
              pagination_token?: string;
              reverse_order?: boolean;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { flow_id: string; run_id: string }
        • flow_id: string

          The ID for the Flow which launched the Run.

        • run_id: string

          The ID for the Run whose log is getting pulled.

      • Optionalquery?: { limit?: number; pagination_token?: string; reverse_order?: boolean }
        • Optionallimit?: number

          An integer limit on the number of log records returned.

        • Optionalpagination_token?: string

          A token used to iterate through pages of returned log records.

        • Optionalreverse_order?: boolean

          A flag to indicate if log records should be returned in reverse order.

    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/flows/{flow_id}/actions/{action_id}/resume": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string; run_id: string };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string; run_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            action_id: string;
                            completion_time: string;
                            details: Record<string, never>;
                            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";
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { flow_id: string; run_id: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { flow_id: string; run_id: string }
        • flow_id: string

          The ID for the Flow which launched the Run.

        • run_id: string

          The ID for the Run whose data is being resumed.

      • Optionalquery?: undefined
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { flow_id: string; run_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          action_id: string;
                          completion_time: string;
                          details: Record<string, never>;
                          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";
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Resume a Run

      Attempt to resume a Run, particularly when it has reached a status of INACTIVE. A Flow Run may reach an INACTIVE status when an Action type state within the Flow returns its status as INACTIVE. The resume operation on the Flow Run provides a hint that the cause of the Action becoming INACTIVE may have been cleared, and thus the resume operation on the Action Provider should be invoked to allow the Action state to resume and thus resume the Flow Run.

      In the particular case that an Action state is INACTIVE with a
      code value of "ConsentRequired" it is further assumed that the
      Bearer token provided in the Authorization header on the
      resume operation now carries sufficient consents to continue
      the INACTIVE Action. Thus, the Flow service will use the
      Bearer token to generate new dependent tokens for running the
      Action and use these tokens to request that the Action be
      resumed at the Action Provider.
      
      Note again that in reasons other than "ConsentRequired" for a
      Flow or Action to go INACTIVE, the resume operation is just a
      hint. For example, when the code is "ActivationRequired,"
      indicating that a Globus collection or endpoint needs to be
      Activated by the user, performing that Activation out-of-band
      from the Flow will allow the Flow to proceed even without the
      resume operation as the Action is periodically polled for
      progress. Performing the resume operation may simply cause a
      poll to happen more quickly and thus allow the Action to
      resume more quickly.
      
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string; run_id: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { flow_id: string; run_id: string }
          • flow_id: string

            The ID for the Flow which launched the Run.

          • run_id: string

            The ID for the Run whose data is being resumed.

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        action_id: string;
                        completion_time: string;
                        details: Record<string, never>;
                        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";
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      action_id: string;
                      completion_time: string;
                      details: Record<string, never>;
                      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";
                  };
              };
              headers: { [name: string]: unknown };
          }

          The request was successful.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The requested Run or Flow was not found. Or, the requestor did not have access to manage the Run.

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/flows/{flow_id}/run": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        activity_notification_policy?: {
                            status: ("SUCCEEDED" | "FAILED" | "INACTIVE")[];
                        };
                        body: { [key: string]: unknown };
                        label?: string;
                        run_managers?: string[];
                        run_monitors?: string[];
                        tags?: string[];
                    };
                };
            };
            responses: {
                "200": { content?: undefined; headers: { [name: string]: unknown } };
                "201": {
                    content: {
                        "application/json": {
                            action_id: string;
                            completion_time: string;
                            details: Record<string, never>;
                            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";
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": { content?: undefined; headers: { [name: string]: unknown } };
                "403": { content?: undefined; headers: { [name: string]: unknown } };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
                "422": { content?: undefined; headers: { [name: string]: unknown } };
                "429": { content?: undefined; headers: { [name: string]: unknown } };
                "502": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { flow_id: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { flow_id: string }
        • flow_id: string

          The ID for the Flow to run.

      • Optionalquery?: undefined
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { flow_id: string };
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      activity_notification_policy?: {
                          status: ("SUCCEEDED" | "FAILED" | "INACTIVE")[];
                      };
                      body: { [key: string]: unknown };
                      label?: string;
                      run_managers?: string[];
                      run_monitors?: string[];
                      tags?: string[];
                  };
              };
          };
          responses: {
              "200": { content?: undefined; headers: { [name: string]: unknown } };
              "201": {
                  content: {
                      "application/json": {
                          action_id: string;
                          completion_time: string;
                          details: Record<string, never>;
                          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";
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": { content?: undefined; headers: { [name: string]: unknown } };
              "403": { content?: undefined; headers: { [name: string]: unknown } };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
              "422": { content?: undefined; headers: { [name: string]: unknown } };
              "429": { content?: undefined; headers: { [name: string]: unknown } };
              "502": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Start a Flow

      Start a particular Flow, which creates a Run.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { flow_id: string }
          • flow_id: string

            The ID for the Flow to run.

        • Optionalquery?: undefined
      • requestBody: {
            content: {
                "application/json": {
                    activity_notification_policy?: {
                        status: ("SUCCEEDED" | "FAILED" | "INACTIVE")[];
                    };
                    body: { [key: string]: unknown };
                    label?: string;
                    run_managers?: string[];
                    run_monitors?: string[];
                    tags?: string[];
                };
            };
        }
      • responses: {
            "200": { content?: undefined; headers: { [name: string]: unknown } };
            "201": {
                content: {
                    "application/json": {
                        action_id: string;
                        completion_time: string;
                        details: Record<string, never>;
                        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";
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": { content?: undefined; headers: { [name: string]: unknown } };
            "403": { content?: undefined; headers: { [name: string]: unknown } };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
            "422": { content?: undefined; headers: { [name: string]: unknown } };
            "429": { content?: undefined; headers: { [name: string]: unknown } };
            "502": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: { content?: undefined; headers: { [name: string]: unknown } }

          The Run inputs were successfully validated during a dry-run.

        • 201: {
              content: {
                  "application/json": {
                      action_id: string;
                      completion_time: string;
                      details: Record<string, never>;
                      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";
                  };
              };
              headers: { [name: string]: unknown };
          }

          The Run was successfully started.

        • 400: { content?: undefined; headers: { [name: string]: unknown } }

          The Run's input failed validation against the Flow's input schema.

        • 403: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor presented a token with insufficient scopes.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor did not have access to run the provided Flow, or the Flow does not exist.

        • 422: { content?: undefined; headers: { [name: string]: unknown } }

          The input tags did not pass validation.

        • 429: { content?: undefined; headers: { [name: string]: unknown } }

          An upstream service has imposed rate limiting. The requestor may resubmit the API request.

        • 502: { content?: undefined; headers: { [name: string]: unknown } }

          An upstream service returned an uncorrectable error. The error may or may not occur if the API request is submitted again. It may be possible to resubmit the API request.

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/flows/{flow_id}/runs": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string };
                query?: {
                    filter_completion_time?: string;
                    filter_label?: string[];
                    filter_role?:
                        | "run_manager"
                        | "run_monitor"
                        | "run_owner"
                        | "flow_run_manager"
                        | "flow_run_monitor";
                    filter_roles?: (
                        | "run_manager"
                        | "run_monitor"
                        | "run_owner"
                        | "flow_run_manager"
                        | "flow_run_monitor"
                    )[];
                    filter_start_time?: string;
                    filter_status?: (
                        "SUCCEEDED"
                        | "FAILED"
                        | "ACTIVE"
                        | "INACTIVE"
                        | "ENDED"
                    )[];
                    marker?: string;
                    orderby?: string[];
                    page?: number;
                    pagination_token?: string;
                    per_page?: number;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            actions: {
                                action_id: string;
                                completion_time: string;
                                details: Record<string, never>;
                                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";
                            }[];
                            has_next_page: boolean;
                            marker?: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": { content?: undefined; headers: { [name: string]: unknown } };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { flow_id: string };
              query?: {
                  filter_completion_time?: string;
                  filter_label?: string[];
                  filter_role?:
                      | "run_manager"
                      | "run_monitor"
                      | "run_owner"
                      | "flow_run_manager"
                      | "flow_run_monitor";
                  filter_roles?: (
                      | "run_manager"
                      | "run_monitor"
                      | "run_owner"
                      | "flow_run_manager"
                      | "flow_run_monitor"
                  )[];
                  filter_start_time?: string;
                  filter_status?: (
                      "SUCCEEDED"
                      | "FAILED"
                      | "ACTIVE"
                      | "INACTIVE"
                      | "ENDED"
                  )[];
                  marker?: string;
                  orderby?: string[];
                  page?: number;
                  pagination_token?: string;
                  per_page?: number;
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          actions: {
                              action_id: string;
                              completion_time: string;
                              details: Record<string, never>;
                              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";
                          }[];
                          has_next_page: boolean;
                          marker?: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": { content?: undefined; headers: { [name: string]: unknown } };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Get a Flow's Runs

      Retrieve a listing of Runs launched from a particular Flow. If hitting the */actions endpoint, the response will list the Runs under a "actions" key. If hitting the */runs endpoint, the response will list the Runs under a "runs" key.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string };
            query?: {
                filter_completion_time?: string;
                filter_label?: string[];
                filter_role?:
                    | "run_manager"
                    | "run_monitor"
                    | "run_owner"
                    | "flow_run_manager"
                    | "flow_run_monitor";
                filter_roles?: (
                    | "run_manager"
                    | "run_monitor"
                    | "run_owner"
                    | "flow_run_manager"
                    | "flow_run_monitor"
                )[];
                filter_start_time?: string;
                filter_status?: ("SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED")[];
                marker?: string;
                orderby?: string[];
                page?: number;
                pagination_token?: string;
                per_page?: number;
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { flow_id: string }
          • flow_id: string

            The ID for the Flow which launched the Runs.

        • Optionalquery?: {
              filter_completion_time?: string;
              filter_label?: string[];
              filter_role?:
                  | "run_manager"
                  | "run_monitor"
                  | "run_owner"
                  | "flow_run_manager"
                  | "flow_run_monitor";
              filter_roles?: (
                  | "run_manager"
                  | "run_monitor"
                  | "run_owner"
                  | "flow_run_manager"
                  | "flow_run_monitor"
              )[];
              filter_start_time?: string;
              filter_status?: ("SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED")[];
              marker?: string;
              orderby?: string[];
              page?: number;
              pagination_token?: string;
              per_page?: number;
          }
          • Optionalfilter_completion_time?: string

            Given a pair of comma separated ISO 8601 date/time strings, filter results to only those Actions whose completion time is within the specified range. If one of the dates is omitted, it forms an open range, so "dt," returns all records with date greater or equal to dt, and ",dt" returns all records with dates less than dt. If there is no comma, it is treated in the same way as "dt,". Results will contain Actions which completed between the first date/time string onwards, up to (but not including) the second date/time string. Note that Actions which are still running will have null completion times and thus cannot be filtered by this field.

            2021-03-09T21:52:14,2021-03-09T21:53
            
          • Optionalfilter_label?: string[]

            Performs a case insensitive string based search on the Actions' label fields. If multiple values are specified, each Action returned is guaranteed to contain at least one of the strings in its label.

            science,tests
            
          • Optionalfilter_role?:
                | "run_manager"
                | "run_monitor"
                | "run_owner"
                | "flow_run_manager"
                | "flow_run_monitor"

            Return Actions for which the user has the provided role. The role the user has on the Action dictates the operations they can perform. Roles are cumulative in the sense that having, for example, the "run_manager" role also implies having the "run_monitor" role. Thus, specifying manager will also include all Actions for which the user has "run_monitor" role as well. If not provided, only Actions for which the caller has "run_owner" role will be returned.

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

            Return Actions for which the user has the supplied role. The role the user has on the Action dictates the operations they can perform. If multiple roles are specified, the user will have at least one of the specified roles on each Action returned.

            run_manager
            
          • Optionalfilter_start_time?: string

            Given a pair of comma separated ISO 8601 date/time strings, filter results to only those Actions which started running within the specified range. If one of the dates is omitted, it forms an open range, so "dt," returns all records with date greater or equal to dt, and ",dt" returns all records with dates less than dt. If there is no comma, it is treated in the same way as "dt,". Results will contain Actions which began between the first date/time string onwards, up to (but not including) the second date/time string.

            2021-03-09T21:52:14,2021-03-09T21:53
            
          • Optionalfilter_status?: ("SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED")[]

            Return Actions which are in the specified state. The state of the Action dictates the operations which can performed on them. If multiple statuses are specified, each Action returned will be in one of the specified states. By default, Actions in any state will be returned.

            FAILED,INACTIVE
            
          • Optionalmarker?: string

            An opaque token used to iterate through pages of returned Actions. If provided, all other query arguments will be ignored. The marker encodes all state in a given query, therefore it's unnecessary to provide query arguments once an initial marker has been received.

          • Optionalorderby?: string[]

            An ordering criteria to apply to the resulting Action listing. The first value indicates the field to order on, and the second value indicates the sorting order. The first ordering criteria will be used to sort the data, subsequent ordering criteria will be applied for ties.

            Fields that support ordering are:
              - id
              - start_time
              - completion_time
              - status
              - label
            
            Supported orderings are:
              - ASC
              - DESC
            
            orderby=id ASC
            
            start_time ASC,id DESC
            
          • Optionalpage?: number

            The page of results to return.

            2
            
          • Optionalpagination_token?: string

            ("marker" is now the preferred name for this parameter.) An opaque token used to iterate through pages of returned Actions. If provided, all other query arguments will be ignored. The pagination_token encodes all state in a given query, therefore it's unnecessary to provide query arguments once an initial token has been received.

          • Optionalper_page?: number

            The number of results to return in a single paged response.

            50
            
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        actions: {
                            action_id: string;
                            completion_time: string;
                            details: Record<string, never>;
                            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";
                        }[];
                        has_next_page: boolean;
                        marker?: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": { content?: undefined; headers: { [name: string]: unknown } };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      actions: {
                          action_id: string;
                          completion_time: string;
                          details: Record<string, never>;
                          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";
                      }[];
                      has_next_page: boolean;
                      marker?: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          The request was successfully received.

        • 403: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor presented a token with insufficient scopes.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The Flow does not exist or the requestor did not have access to enumerate the Flow's Actions.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { flow_id: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { flow_id: string }
        • flow_id: string

          The ID for the Flow which launched the Runs.

      • Optionalquery?: undefined
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/flows/{flow_id}/runs/{run_id}/log": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string; run_id: string };
                query?: {
                    limit?: number;
                    pagination_token?: string;
                    reverse_order?: boolean;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            entries: Record<string, never>[];
                            has_next_page: boolean;
                            limit: number;
                            marker?: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": { content?: undefined; headers: { [name: string]: unknown } };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string; run_id: string };
            query?: {
                limit?: number;
                pagination_token?: string;
                reverse_order?: boolean;
            };
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { flow_id: string; run_id: string };
              query?: {
                  limit?: number;
                  pagination_token?: string;
                  reverse_order?: boolean;
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          entries: Record<string, never>[];
                          has_next_page: boolean;
                          limit: number;
                          marker?: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": { content?: undefined; headers: { [name: string]: unknown } };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Get execution details on a Run

      Retrieve detailed execution information for a particular Flow Run

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string; run_id: string };
            query?: {
                limit?: number;
                pagination_token?: string;
                reverse_order?: boolean;
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { flow_id: string; run_id: string }
          • flow_id: string

            The ID for the Flow which launched the Run.

          • run_id: string

            The ID for the Run whose log is getting pulled.

        • Optionalquery?: { limit?: number; pagination_token?: string; reverse_order?: boolean }
          • Optionallimit?: number

            An integer limit on the number of log records returned.

          • Optionalpagination_token?: string

            A token used to iterate through pages of returned log records.

          • Optionalreverse_order?: boolean

            A flag to indicate if log records should be returned in reverse order.

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        entries: Record<string, never>[];
                        has_next_page: boolean;
                        limit: number;
                        marker?: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": { content?: undefined; headers: { [name: string]: unknown } };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      entries: Record<string, never>[];
                      has_next_page: boolean;
                      limit: number;
                      marker?: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          The request was successfully received.

        • 400: { content?: undefined; headers: { [name: string]: unknown } }

          There was an issue parsing the query parameters.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The requested Action or Flow was not found. Or, the requestor did not have access to view the Action.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { flow_id: string; run_id: string };
          query?: {
              limit?: number;
              pagination_token?: string;
              reverse_order?: boolean;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { flow_id: string; run_id: string }
        • flow_id: string

          The ID for the Flow which launched the Run.

        • run_id: string

          The ID for the Run whose log is getting pulled.

      • Optionalquery?: { limit?: number; pagination_token?: string; reverse_order?: boolean }
        • Optionallimit?: number

          An integer limit on the number of log records returned.

        • Optionalpagination_token?: string

          A token used to iterate through pages of returned log records.

        • Optionalreverse_order?: boolean

          A flag to indicate if log records should be returned in reverse order.

    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/flows/{flow_id}/runs/{run_id}/resume": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string; run_id: string };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string; run_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            action_id: string;
                            completion_time: string;
                            details: Record<string, never>;
                            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";
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { flow_id: string; run_id: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { flow_id: string; run_id: string }
        • flow_id: string

          The ID for the Flow which launched the Run.

        • run_id: string

          The ID for the Run whose data is being resumed.

      • Optionalquery?: undefined
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { flow_id: string; run_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          action_id: string;
                          completion_time: string;
                          details: Record<string, never>;
                          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";
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Resume a Run

      Attempt to resume a Run, particularly when it has reached a status of INACTIVE. A Flow Run may reach an INACTIVE status when an Action type state within the Flow returns its status as INACTIVE. The resume operation on the Flow Run provides a hint that the cause of the Action becoming INACTIVE may have been cleared, and thus the resume operation on the Action Provider should be invoked to allow the Action state to resume and thus resume the Flow Run.

      In the particular case that an Action state is INACTIVE with a
      code value of "ConsentRequired" it is further assumed that the
      Bearer token provided in the Authorization header on the
      resume operation now carries sufficient consents to continue
      the INACTIVE Action. Thus, the Flow service will use the
      Bearer token to generate new dependent tokens for running the
      Action and use these tokens to request that the Action be
      resumed at the Action Provider.
      
      Note again that in reasons other than "ConsentRequired" for a
      Flow or Action to go INACTIVE, the resume operation is just a
      hint. For example, when the code is "ActivationRequired,"
      indicating that a Globus collection or endpoint needs to be
      Activated by the user, performing that Activation out-of-band
      from the Flow will allow the Flow to proceed even without the
      resume operation as the Action is periodically polled for
      progress. Performing the resume operation may simply cause a
      poll to happen more quickly and thus allow the Action to
      resume more quickly.
      
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string; run_id: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { flow_id: string; run_id: string }
          • flow_id: string

            The ID for the Flow which launched the Run.

          • run_id: string

            The ID for the Run whose data is being resumed.

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        action_id: string;
                        completion_time: string;
                        details: Record<string, never>;
                        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";
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      action_id: string;
                      completion_time: string;
                      details: Record<string, never>;
                      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";
                  };
              };
              headers: { [name: string]: unknown };
          }

          The request was successful.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The requested Run or Flow was not found. Or, the requestor did not have access to manage the Run.

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/flows/{flow_id}/start": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        body: { [key: string]: unknown };
                        tags?: string[];
                    };
                };
            };
            responses: {
                "200": { content?: undefined; headers: { [name: string]: unknown } };
                "201": {
                    content: {
                        "application/json": {
                            action_id: string;
                            completion_time: string;
                            details: Record<string, never>;
                            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";
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": { content?: undefined; headers: { [name: string]: unknown } };
                "403": { content?: undefined; headers: { [name: string]: unknown } };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
                "422": { content?: undefined; headers: { [name: string]: unknown } };
                "429": { content?: undefined; headers: { [name: string]: unknown } };
                "502": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { flow_id: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { flow_id: string }
        • flow_id: string

          The ID for the Flow to run.

      • Optionalquery?: undefined
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { flow_id: string };
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      body: { [key: string]: unknown };
                      tags?: string[];
                  };
              };
          };
          responses: {
              "200": { content?: undefined; headers: { [name: string]: unknown } };
              "201": {
                  content: {
                      "application/json": {
                          action_id: string;
                          completion_time: string;
                          details: Record<string, never>;
                          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";
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": { content?: undefined; headers: { [name: string]: unknown } };
              "403": { content?: undefined; headers: { [name: string]: unknown } };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
              "422": { content?: undefined; headers: { [name: string]: unknown } };
              "429": { content?: undefined; headers: { [name: string]: unknown } };
              "502": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Start a Flow

      Start a particular Flow, which creates a Run.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { flow_id: string }
          • flow_id: string

            The ID for the Flow to run.

        • Optionalquery?: undefined
      • requestBody: {
            content: {
                "application/json": {
                    body: { [key: string]: unknown };
                    tags?: string[];
                };
            };
        }
      • responses: {
            "200": { content?: undefined; headers: { [name: string]: unknown } };
            "201": {
                content: {
                    "application/json": {
                        action_id: string;
                        completion_time: string;
                        details: Record<string, never>;
                        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";
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": { content?: undefined; headers: { [name: string]: unknown } };
            "403": { content?: undefined; headers: { [name: string]: unknown } };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
            "422": { content?: undefined; headers: { [name: string]: unknown } };
            "429": { content?: undefined; headers: { [name: string]: unknown } };
            "502": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: { content?: undefined; headers: { [name: string]: unknown } }

          The Run inputs were successfully validated during a dry-run.

        • 201: {
              content: {
                  "application/json": {
                      action_id: string;
                      completion_time: string;
                      details: Record<string, never>;
                      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";
                  };
              };
              headers: { [name: string]: unknown };
          }

          The Run was successfully started.

        • 400: { content?: undefined; headers: { [name: string]: unknown } }

          The Run's input failed validation against the Flow's input schema.

        • 403: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor presented a token with insufficient scopes.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor did not have access to run the provided Flow, or the Flow does not exist.

        • 422: { content?: undefined; headers: { [name: string]: unknown } }

          The input tags did not pass validation.

        • 429: { content?: undefined; headers: { [name: string]: unknown } }

          An upstream service has imposed rate limiting. The requestor may resubmit the API request.

        • 502: { content?: undefined; headers: { [name: string]: unknown } }

          An upstream service returned an uncorrectable error. The error may or may not occur if the API request is submitted again. It may be possible to resubmit the API request.

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/flows/{flow_id}/validate_run": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        activity_notification_policy?: {
                            status: ("SUCCEEDED" | "FAILED" | "INACTIVE")[];
                        };
                        body: { [key: string]: unknown };
                        label?: string;
                        run_managers?: string[];
                        run_monitors?: string[];
                        tags?: string[];
                    };
                };
            };
            responses: {
                "200": {
                    content: { "application/json": { message: string } };
                    headers: { [name: string]: unknown };
                };
                "400": { content?: undefined; headers: { [name: string]: unknown } };
                "403": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      activity_notification_policy?: {
                          status: ("SUCCEEDED" | "FAILED" | "INACTIVE")[];
                      };
                      body: { [key: string]: unknown };
                      label?: string;
                      run_managers?: string[];
                      run_monitors?: string[];
                      tags?: string[];
                  };
              };
          };
          responses: {
              "200": {
                  content: { "application/json": { message: string } };
                  headers: { [name: string]: unknown };
              };
              "400": { content?: undefined; headers: { [name: string]: unknown } };
              "403": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Validate a run

      Validate that a run input body will pass the target flow's input schema validation (if any), that run metadata will meet the Flows service's metadata constraints, and that known scope requirements are met by the user's or client's Globus Auth token.

      If validation passes, then it is likely that the flow can be started
      with the same inputs and Globus Auth token.
      
      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • requestBody: {
            content: {
                "application/json": {
                    activity_notification_policy?: {
                        status: ("SUCCEEDED" | "FAILED" | "INACTIVE")[];
                    };
                    body: { [key: string]: unknown };
                    label?: string;
                    run_managers?: string[];
                    run_monitors?: string[];
                    tags?: string[];
                };
            };
        }
      • responses: {
            "200": {
                content: { "application/json": { message: string } };
                headers: { [name: string]: unknown };
            };
            "400": { content?: undefined; headers: { [name: string]: unknown } };
            "403": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: { "application/json": { message: string } };
              headers: { [name: string]: unknown };
          }

          The inputs and Globus Auth token passed validation.

          It is likely that the user or client will be able to start the flow
          using the same Globus Auth token and input values.
          
        • 400: { content?: undefined; headers: { [name: string]: unknown } }

          The input body failed validation against the flow's input schema.

        • 403: { content?: undefined; headers: { [name: string]: unknown } }

          The user or client is not allowed to run the flow, or the Globus Auth token is missing required scopes.

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/flows/validate": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        definition: {
                            Comment?: string;
                            StartAt: string;
                            States: {
                                [key: string]: | {
                                    Comment?: unknown;
                                    End?: unknown;
                                    InputPath?: unknown;
                                    Next?: unknown;
                                    Parameters?: unknown;
                                    ResultPath?: unknown;
                                    Type?: (...)
                                    | (...);
                                } & { End?: (...)
                                | (...)
                                | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                    InputPath?: (...) | (...);
                                } & { ResultPath?: (...)
                                | (...) }
                                | {
                                    ActionScope?: (...) | (...);
                                    ActionUrl: string;
                                    Catch?: unknown;
                                    Comment?: unknown;
                                    End?: unknown;
                                    ExceptionOnActionFailure: boolean;
                                    InputPath?: unknown;
                                    Next?: unknown;
                                    Parameters?: unknown;
                                    ResultPath?: unknown;
                                    RunAs?: (...) | (...);
                                    Type: string;
                                    WaitTime?: (...) | (...);
                                } & { End?: (...)
                                | (...)
                                | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                    InputPath?: (...) | (...);
                                } & { ResultPath?: (...)
                                | (...) } & { Catch?: (...) | (...) }
                                | {
                                    Comment?: unknown;
                                    Next?: string;
                                    Seconds?: number;
                                    SecondsPath?: string;
                                    Timestamp?: string;
                                    TimestampPath?: string;
                                    Type?: string;
                                }
                                | {
                                    Choices: ((...) & (...))[];
                                    Comment?: string;
                                    Default?: string;
                                    Type?: string;
                                }
                                | {
                                    Comment?: unknown;
                                    Next: string;
                                    Parameters: unknown;
                                    ResultPath: unknown;
                                    Type?: (...)
                                    | (...);
                                } & { Parameters?: (...)
                                | (...) } & { ResultPath?: (...) | (...) }
                                | { Cause?: string; Comment?: string; Error?: string; Type?: string };
                            };
                        };
                        input_schema?: Record<string, never>;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": { scopes?: { [key: string]: string[] } };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": { content?: undefined; headers: { [name: string]: unknown } };
                "403": { content?: undefined; headers: { [name: string]: unknown } };
                "409": { content?: undefined; headers: { [name: string]: unknown } };
                "422": {
                    content: {
                        "application/json": {
                            debug_id: string;
                            error: {
                                code: string;
                                detail: string | { loc: (...)[]; msg: string; type: string }[];
                                message?: string;
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      definition: {
                          Comment?: string;
                          StartAt: string;
                          States: {
                              [key: string]: | {
                                  Comment?: unknown;
                                  End?: unknown;
                                  InputPath?: unknown;
                                  Next?: unknown;
                                  Parameters?: unknown;
                                  ResultPath?: unknown;
                                  Type?: (...)
                                  | (...);
                              } & { End?: (...)
                              | (...)
                              | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                  InputPath?: (...) | (...);
                              } & { ResultPath?: (...)
                              | (...) }
                              | {
                                  ActionScope?: (...) | (...);
                                  ActionUrl: string;
                                  Catch?: unknown;
                                  Comment?: unknown;
                                  End?: unknown;
                                  ExceptionOnActionFailure: boolean;
                                  InputPath?: unknown;
                                  Next?: unknown;
                                  Parameters?: unknown;
                                  ResultPath?: unknown;
                                  RunAs?: (...) | (...);
                                  Type: string;
                                  WaitTime?: (...) | (...);
                              } & { End?: (...)
                              | (...)
                              | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                  InputPath?: (...) | (...);
                              } & { ResultPath?: (...)
                              | (...) } & { Catch?: (...) | (...) }
                              | {
                                  Comment?: unknown;
                                  Next?: string;
                                  Seconds?: number;
                                  SecondsPath?: string;
                                  Timestamp?: string;
                                  TimestampPath?: string;
                                  Type?: string;
                              }
                              | {
                                  Choices: ((...) & (...))[];
                                  Comment?: string;
                                  Default?: string;
                                  Type?: string;
                              }
                              | {
                                  Comment?: unknown;
                                  Next: string;
                                  Parameters: unknown;
                                  ResultPath: unknown;
                                  Type?: (...)
                                  | (...);
                              } & { Parameters?: (...)
                              | (...) } & { ResultPath?: (...) | (...) }
                              | { Cause?: string; Comment?: string; Error?: string; Type?: string };
                          };
                      };
                      input_schema?: Record<string, never>;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": { scopes?: { [key: string]: string[] } };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": { content?: undefined; headers: { [name: string]: unknown } };
              "403": { content?: undefined; headers: { [name: string]: unknown } };
              "409": { content?: undefined; headers: { [name: string]: unknown } };
              "422": {
                  content: {
                      "application/json": {
                          debug_id: string;
                          error: {
                              code: string;
                              detail: string | { loc: (...)[]; msg: string; type: string }[];
                              message?: string;
                          };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Validate a flow

      Validate a flow definition and its schema.

      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • requestBody: {
            content: {
                "application/json": {
                    definition: {
                        Comment?: string;
                        StartAt: string;
                        States: {
                            [key: string]:
                                | {
                                    Comment?: unknown;
                                    End?: unknown;
                                    InputPath?: unknown;
                                    Next?: unknown;
                                    Parameters?: unknown;
                                    ResultPath?: unknown;
                                    Type?: (...)
                                    | (...);
                                } & { End?: (...)
                                | (...)
                                | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                    InputPath?: (...) | (...);
                                } & { ResultPath?: (...)
                                | (...) }
                                | {
                                    ActionScope?: (...) | (...);
                                    ActionUrl: string;
                                    Catch?: unknown;
                                    Comment?: unknown;
                                    End?: unknown;
                                    ExceptionOnActionFailure: boolean;
                                    InputPath?: unknown;
                                    Next?: unknown;
                                    Parameters?: unknown;
                                    ResultPath?: unknown;
                                    RunAs?: (...) | (...);
                                    Type: string;
                                    WaitTime?: (...) | (...);
                                } & { End?: (...)
                                | (...)
                                | (...); Next?: (...) | (...) } & { Parameters?: (...) | (...) } & {
                                    InputPath?: (...) | (...);
                                } & { ResultPath?: (...)
                                | (...) } & { Catch?: (...) | (...) }
                                | {
                                    Comment?: unknown;
                                    Next?: string;
                                    Seconds?: number;
                                    SecondsPath?: string;
                                    Timestamp?: string;
                                    TimestampPath?: string;
                                    Type?: string;
                                }
                                | {
                                    Choices: ((...) & (...))[];
                                    Comment?: string;
                                    Default?: string;
                                    Type?: string;
                                }
                                | {
                                    Comment?: unknown;
                                    Next: string;
                                    Parameters: unknown;
                                    ResultPath: unknown;
                                    Type?: (...)
                                    | (...);
                                } & { Parameters?: (...)
                                | (...) } & { ResultPath?: (...) | (...) }
                                | { Cause?: string; Comment?: string; Error?: string; Type?: string };
                        };
                    };
                    input_schema?: Record<string, never>;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": { scopes?: { [key: string]: string[] } };
                };
                headers: { [name: string]: unknown };
            };
            "400": { content?: undefined; headers: { [name: string]: unknown } };
            "403": { content?: undefined; headers: { [name: string]: unknown } };
            "409": { content?: undefined; headers: { [name: string]: unknown } };
            "422": {
                content: {
                    "application/json": {
                        debug_id: string;
                        error: {
                            code: string;
                            detail: string | { loc: (...)[]; msg: string; type: string }[];
                            message?: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": { scopes?: { [key: string]: string[] } };
              };
              headers: { [name: string]: unknown };
          }

          The flow passed all validation checks.

        • 400: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor attempted to validate a malformed flow.

        • 403: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor is not authorized to validate a flow.

        • 409: { content?: undefined; headers: { [name: string]: unknown } }

          A conflict was found in the flow definition or input schema.

        • 422: {
              content: {
                  "application/json": {
                      debug_id: string;
                      error: {
                          code: string;
                          detail: string | { loc: (...)[]; msg: string; type: string }[];
                          message?: string;
                      };
                  };
              };
              headers: { [name: string]: unknown };
          }

          The flow definition or input schema failed validation checks.

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/mine": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    roles?: (
                        | "flow_owner"
                        | "flow_viewers"
                        | "flow_starters"
                        | "flow_administrators"
                    )[];
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            flows?: {
                                api_version?: "1.0";
                                created_at?: string;
                                definition?: { Comment?: ...; StartAt: ...; States: ... };
                                description?: string;
                                flow_administrators?: (...)[];
                                flow_owner?: string;
                                flow_starters?: (...)[];
                                flow_url?: string;
                                flow_viewers?: (...)[];
                                globus_auth_scope?: string;
                                globus_auth_scopes_by_RunAs?: (...)[];
                                globus_auth_username?: string;
                                id?: string;
                                input_schema?: Record<(...), (...)>;
                                keywords?: (...)[];
                                log_supported?: boolean;
                                principal_urn?: string;
                                subscription_id?: string;
                                subtitle?: string;
                                synchronous?: boolean;
                                title?: string;
                                types?: (...)[];
                                updated_at?: string;
                                user_role?:
                                    | "flow_owner"
                                    | "flow_viewer"
                                    | "flow_starter"
                                    | "flow_administrator";
                            }[];
                            has_next_page?: boolean;
                            limit?: number;
                            marker?: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": { content?: undefined; headers: { [name: string]: unknown } };
                "403": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: {
                  roles?: (
                      | "flow_owner"
                      | "flow_viewers"
                      | "flow_starters"
                      | "flow_administrators"
                  )[];
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          flows?: {
                              api_version?: "1.0";
                              created_at?: string;
                              definition?: { Comment?: ...; StartAt: ...; States: ... };
                              description?: string;
                              flow_administrators?: (...)[];
                              flow_owner?: string;
                              flow_starters?: (...)[];
                              flow_url?: string;
                              flow_viewers?: (...)[];
                              globus_auth_scope?: string;
                              globus_auth_scopes_by_RunAs?: (...)[];
                              globus_auth_username?: string;
                              id?: string;
                              input_schema?: Record<(...), (...)>;
                              keywords?: (...)[];
                              log_supported?: boolean;
                              principal_urn?: string;
                              subscription_id?: string;
                              subtitle?: string;
                              synchronous?: boolean;
                              title?: string;
                              types?: (...)[];
                              updated_at?: string;
                              user_role?:
                                  | "flow_owner"
                                  | "flow_viewer"
                                  | "flow_starter"
                                  | "flow_administrator";
                          }[];
                          has_next_page?: boolean;
                          limit?: number;
                          marker?: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": { content?: undefined; headers: { [name: string]: unknown } };
              "403": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Retrieve all Flows

      Query the Flows service for a listing of Flows available to a user according to the permissions (role) they have on the Flow.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                roles?: (
                    | "flow_owner"
                    | "flow_viewers"
                    | "flow_starters"
                    | "flow_administrators"
                )[];
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • Optionalpath?: undefined
        • Optionalquery?: {
              roles?: (
                  "flow_owner"
                  | "flow_viewers"
                  | "flow_starters"
                  | "flow_administrators"
              )[];
          }
          • Optionalroles?: ("flow_owner" | "flow_viewers" | "flow_starters" | "flow_administrators")[]

            Return Flow's for which the user has the supplied role. The role the user has on the Flow dictates the operations they can perform.

            flow_owner,flow_viewers
            
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        flows?: {
                            api_version?: "1.0";
                            created_at?: string;
                            definition?: { Comment?: ...; StartAt: ...; States: ... };
                            description?: string;
                            flow_administrators?: (...)[];
                            flow_owner?: string;
                            flow_starters?: (...)[];
                            flow_url?: string;
                            flow_viewers?: (...)[];
                            globus_auth_scope?: string;
                            globus_auth_scopes_by_RunAs?: (...)[];
                            globus_auth_username?: string;
                            id?: string;
                            input_schema?: Record<(...), (...)>;
                            keywords?: (...)[];
                            log_supported?: boolean;
                            principal_urn?: string;
                            subscription_id?: string;
                            subtitle?: string;
                            synchronous?: boolean;
                            title?: string;
                            types?: (...)[];
                            updated_at?: string;
                            user_role?:
                                | "flow_owner"
                                | "flow_viewer"
                                | "flow_starter"
                                | "flow_administrator";
                        }[];
                        has_next_page?: boolean;
                        limit?: number;
                        marker?: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": { content?: undefined; headers: { [name: string]: unknown } };
            "403": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      flows?: {
                          api_version?: "1.0";
                          created_at?: string;
                          definition?: { Comment?: ...; StartAt: ...; States: ... };
                          description?: string;
                          flow_administrators?: (...)[];
                          flow_owner?: string;
                          flow_starters?: (...)[];
                          flow_url?: string;
                          flow_viewers?: (...)[];
                          globus_auth_scope?: string;
                          globus_auth_scopes_by_RunAs?: (...)[];
                          globus_auth_username?: string;
                          id?: string;
                          input_schema?: Record<(...), (...)>;
                          keywords?: (...)[];
                          log_supported?: boolean;
                          principal_urn?: string;
                          subscription_id?: string;
                          subtitle?: string;
                          synchronous?: boolean;
                          title?: string;
                          types?: (...)[];
                          updated_at?: string;
                          user_role?:
                              | "flow_owner"
                              | "flow_viewer"
                              | "flow_starter"
                              | "flow_administrator";
                      }[];
                      has_next_page?: boolean;
                      limit?: number;
                      marker?: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          The requestor has successfully authenticated and queried the Flow's service for the Flows available for them.

        • 400: { content?: undefined; headers: { [name: string]: unknown } }

          There was an issue parsing the query parameters.

        • 403: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor presented a token with insufficient scopes.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/runs": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    filter_completion_time?: string;
                    filter_flow_id?: string[];
                    filter_flow_title?: string[];
                    filter_label?: string[];
                    filter_role?: "run_manager" | "run_monitor" | "run_owner";
                    filter_roles?: (
                        | "run_managers"
                        | "run_monitors"
                        | "run_owner"
                        | "flow_run_managers"
                        | "flow_run_monitors"
                    )[];
                    filter_start_time?: string;
                    filter_status?: (
                        "SUCCEEDED"
                        | "FAILED"
                        | "ACTIVE"
                        | "INACTIVE"
                        | "ENDED"
                    )[];
                    marker?: string;
                    orderby?: string[];
                    page?: number;
                    pagination_token?: string;
                    per_page?: number;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            actions?: {
                                action_id: string;
                                completion_time: string;
                                details: Record<string, never>;
                                display_status?: string;
                                flow_id: string;
                                flow_last_updated: string;
                                label: string;
                                run_id: string;
                                run_managers?: (...)[];
                                run_monitors?: (...)[];
                                run_owner: string;
                                start_time: string;
                                status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED";
                                tags: string[];
                                user_role: "run_manager" | "run_monitor" | "run_owner";
                            }[];
                            has_next_page: boolean;
                            marker?: string;
                            runs?: {
                                action_id: string;
                                completion_time: string;
                                details: Record<string, never>;
                                display_status?: string;
                                flow_id: string;
                                flow_last_updated: string;
                                label: string;
                                run_id: string;
                                run_managers?: (...)[];
                                run_monitors?: (...)[];
                                run_owner: string;
                                start_time: string;
                                status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED";
                                tags: string[];
                                user_role: "run_manager" | "run_monitor" | "run_owner";
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": { content?: undefined; headers: { [name: string]: unknown } };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: {
                  filter_completion_time?: string;
                  filter_flow_id?: string[];
                  filter_flow_title?: string[];
                  filter_label?: string[];
                  filter_role?: "run_manager" | "run_monitor" | "run_owner";
                  filter_roles?: (
                      | "run_managers"
                      | "run_monitors"
                      | "run_owner"
                      | "flow_run_managers"
                      | "flow_run_monitors"
                  )[];
                  filter_start_time?: string;
                  filter_status?: (
                      "SUCCEEDED"
                      | "FAILED"
                      | "ACTIVE"
                      | "INACTIVE"
                      | "ENDED"
                  )[];
                  marker?: string;
                  orderby?: string[];
                  page?: number;
                  pagination_token?: string;
                  per_page?: number;
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          actions?: {
                              action_id: string;
                              completion_time: string;
                              details: Record<string, never>;
                              display_status?: string;
                              flow_id: string;
                              flow_last_updated: string;
                              label: string;
                              run_id: string;
                              run_managers?: (...)[];
                              run_monitors?: (...)[];
                              run_owner: string;
                              start_time: string;
                              status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED";
                              tags: string[];
                              user_role: "run_manager" | "run_monitor" | "run_owner";
                          }[];
                          has_next_page: boolean;
                          marker?: string;
                          runs?: {
                              action_id: string;
                              completion_time: string;
                              details: Record<string, never>;
                              display_status?: string;
                              flow_id: string;
                              flow_last_updated: string;
                              label: string;
                              run_id: string;
                              run_managers?: (...)[];
                              run_monitors?: (...)[];
                              run_owner: string;
                              start_time: string;
                              status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED";
                              tags: string[];
                              user_role: "run_manager" | "run_monitor" | "run_owner";
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": { content?: undefined; headers: { [name: string]: unknown } };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      List all Runs

      Retrieve a listing of Actions/Runs launched across all Flows. If hitting the */actions endpoint, the response will list the Runs under a "actions" key. If hitting the */runs endpoint, the response will list the Runs under a "runs" key.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                filter_completion_time?: string;
                filter_flow_id?: string[];
                filter_flow_title?: string[];
                filter_label?: string[];
                filter_role?: "run_manager" | "run_monitor" | "run_owner";
                filter_roles?: (
                    | "run_managers"
                    | "run_monitors"
                    | "run_owner"
                    | "flow_run_managers"
                    | "flow_run_monitors"
                )[];
                filter_start_time?: string;
                filter_status?: ("SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED")[];
                marker?: string;
                orderby?: string[];
                page?: number;
                pagination_token?: string;
                per_page?: number;
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • Optionalpath?: undefined
        • Optionalquery?: {
              filter_completion_time?: string;
              filter_flow_id?: string[];
              filter_flow_title?: string[];
              filter_label?: string[];
              filter_role?: "run_manager" | "run_monitor" | "run_owner";
              filter_roles?: (
                  | "run_managers"
                  | "run_monitors"
                  | "run_owner"
                  | "flow_run_managers"
                  | "flow_run_monitors"
              )[];
              filter_start_time?: string;
              filter_status?: ("SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED")[];
              marker?: string;
              orderby?: string[];
              page?: number;
              pagination_token?: string;
              per_page?: number;
          }
          • Optionalfilter_completion_time?: string

            Given a pair of comma separated ISO 8601 date/time strings, filter results to only those Actions whose completion time is within the specified range. If one of the dates is omitted, it forms an open range, so "dt," returns all records with date greater or equal to dt, and ",dt" returns all records with dates less than dt. If there is no comma, it is treated in the same way as "dt,". Results will contain Actions which completed between the first date/time string onwards, up to (but not including) the second date/time string. Note that Actions which are still running will have null completion times and thus cannot be filtered by this field.

            2021-03-09T21:52:14,2021-03-09T21:53
            
          • Optionalfilter_flow_id?: string[]

            Performs an equality based search to filter for Runs which were initiated from the specified Flow ID(s). If multiple values are specified, each Run returned will have been initiated from at least one of the specified Flow IDs.

            6086d817-19d9-4f5b-9329-22ed12d4d3dd,71a70751-19a5-4d19-998e-0709c40321e9
            
          • Optionalfilter_flow_title?: string[]

            Performs a case insensitive string based search to filter for Actions which have parent Flow's with a matching title(s). If multiple values are specified, each Action returned will have a parent Flow with a title matching at least one of the strings.

            globus,tests
            
          • Optionalfilter_label?: string[]

            Performs a case insensitive string based search on the Actions' label fields. If multiple values are specified, each Action returned is guaranteed to contain at least one of the strings in its label.

            science,tests
            
          • Optionalfilter_role?: "run_manager" | "run_monitor" | "run_owner"

            Return Runs for which the user has the provided role. The role the user has on the Runs dictates the operations they can perform. Roles are cumulative in the sense that having, for example, the "run_manager" role also implies having the "run_monitor" role. Thus, specifying manager will also include all Runs for which the user has "run_monitor" role as well. If not provided, only Runs for which the caller has "run_owner" role will be returned.

            run_manager
            
          • Optionalfilter_roles?: (
                | "run_managers"
                | "run_monitors"
                | "run_owner"
                | "flow_run_managers"
                | "flow_run_monitors"
            )[]

            Return Runs for which the user has the supplied role. The role the user has on the Action dictates the operations they can perform. If multiple roles are specified, the user will have at least one of the specified roles on each Action returned.

            run_owner,run_managers
            
          • Optionalfilter_start_time?: string

            Given a pair of comma separated ISO 8601 date/time strings, filter results to only those Actions which started running within the specified range. If one of the dates is omitted, it forms an open range, so "dt," returns all records with date greater or equal to dt, and ",dt" returns all records with dates less than dt. If there is no comma, it is treated in the same way as "dt,". Results will contain Actions which began between the first date/time string onwards, up to (but not including) the second date/time string.

            2021-03-09T21:52:14,2021-03-09T21:53
            
          • Optionalfilter_status?: ("SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED")[]

            Return Actions which are in the specified state. The state of the Action dictates the operations which can performed on them. If multiple statuses are specified, each Action returned will be in one of the specified states. By default, Actions in any state will be returned.

            FAILED,INACTIVE
            
          • Optionalmarker?: string

            An opaque token used to iterate through pages of returned Actions. If provided, all other query arguments will be ignored. The marker encodes all state in a given query, therefore it's unnecessary to provide query arguments once an initial marker has been received.

          • Optionalorderby?: string[]

            An ordering criteria to apply to the resulting Action listing. The first value indicates the field to order on, and the second value indicates the sorting order. The first ordering criteria will be used to sort the data, subsequent ordering criteria will be applied for ties.

            Fields that support ordering are:
              - id
              - start_time
              - completion_time
              - status
              - label
              - run_owner
              - flow_title
            
            Supported orderings are:
              - ASC
              - DESC
            
            orderby=start_time DESC
            
            start_time ASC,id DESC
            
          • Optionalpage?: number

            The page of results to return.

            2
            
          • Optionalpagination_token?: string

            ("marker" is now the preferred name for this parameter.) An opaque token used to iterate through pages of returned Actions. If provided, all other query arguments will be ignored. The pagination_token encodes all state in a given query, therefore it's unnecessary to provide query arguments once an initial token has been received.

          • Optionalper_page?: number

            The number of results to return in a single paged response.

            50
            
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        actions?: {
                            action_id: string;
                            completion_time: string;
                            details: Record<string, never>;
                            display_status?: string;
                            flow_id: string;
                            flow_last_updated: string;
                            label: string;
                            run_id: string;
                            run_managers?: (...)[];
                            run_monitors?: (...)[];
                            run_owner: string;
                            start_time: string;
                            status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED";
                            tags: string[];
                            user_role: "run_manager" | "run_monitor" | "run_owner";
                        }[];
                        has_next_page: boolean;
                        marker?: string;
                        runs?: {
                            action_id: string;
                            completion_time: string;
                            details: Record<string, never>;
                            display_status?: string;
                            flow_id: string;
                            flow_last_updated: string;
                            label: string;
                            run_id: string;
                            run_managers?: (...)[];
                            run_monitors?: (...)[];
                            run_owner: string;
                            start_time: string;
                            status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED";
                            tags: string[];
                            user_role: "run_manager" | "run_monitor" | "run_owner";
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": { content?: undefined; headers: { [name: string]: unknown } };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      actions?: {
                          action_id: string;
                          completion_time: string;
                          details: Record<string, never>;
                          display_status?: string;
                          flow_id: string;
                          flow_last_updated: string;
                          label: string;
                          run_id: string;
                          run_managers?: (...)[];
                          run_monitors?: (...)[];
                          run_owner: string;
                          start_time: string;
                          status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED";
                          tags: string[];
                          user_role: "run_manager" | "run_monitor" | "run_owner";
                      }[];
                      has_next_page: boolean;
                      marker?: string;
                      runs?: {
                          action_id: string;
                          completion_time: string;
                          details: Record<string, never>;
                          display_status?: string;
                          flow_id: string;
                          flow_last_updated: string;
                          label: string;
                          run_id: string;
                          run_managers?: (...)[];
                          run_monitors?: (...)[];
                          run_owner: string;
                          start_time: string;
                          status: "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED";
                          tags: string[];
                          user_role: "run_manager" | "run_monitor" | "run_owner";
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          The request was successfully received.

        • 403: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor presented a token with insufficient scopes.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The Flow does not exist or the requestor did not have access to enumerate the Actions.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/runs/{action_id}/log": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string; run_id: string };
                query?: {
                    limit?: number;
                    pagination_token?: string;
                    reverse_order?: boolean;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            entries: Record<string, never>[];
                            has_next_page: boolean;
                            limit: number;
                            marker?: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": { content?: undefined; headers: { [name: string]: unknown } };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string; run_id: string };
            query?: {
                limit?: number;
                pagination_token?: string;
                reverse_order?: boolean;
            };
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { flow_id: string; run_id: string };
              query?: {
                  limit?: number;
                  pagination_token?: string;
                  reverse_order?: boolean;
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          entries: Record<string, never>[];
                          has_next_page: boolean;
                          limit: number;
                          marker?: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": { content?: undefined; headers: { [name: string]: unknown } };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Get execution details on a Run

      Retrieve detailed execution information for a particular Flow Run

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string; run_id: string };
            query?: {
                limit?: number;
                pagination_token?: string;
                reverse_order?: boolean;
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { flow_id: string; run_id: string }
          • flow_id: string

            The ID for the Flow which launched the Run.

          • run_id: string

            The ID for the Run whose log is getting pulled.

        • Optionalquery?: { limit?: number; pagination_token?: string; reverse_order?: boolean }
          • Optionallimit?: number

            An integer limit on the number of log records returned.

          • Optionalpagination_token?: string

            A token used to iterate through pages of returned log records.

          • Optionalreverse_order?: boolean

            A flag to indicate if log records should be returned in reverse order.

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        entries: Record<string, never>[];
                        has_next_page: boolean;
                        limit: number;
                        marker?: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": { content?: undefined; headers: { [name: string]: unknown } };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      entries: Record<string, never>[];
                      has_next_page: boolean;
                      limit: number;
                      marker?: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          The request was successfully received.

        • 400: { content?: undefined; headers: { [name: string]: unknown } }

          There was an issue parsing the query parameters.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The requested Action or Flow was not found. Or, the requestor did not have access to view the Action.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { flow_id: string; run_id: string };
          query?: {
              limit?: number;
              pagination_token?: string;
              reverse_order?: boolean;
          };
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { flow_id: string; run_id: string }
        • flow_id: string

          The ID for the Flow which launched the Run.

        • run_id: string

          The ID for the Run whose log is getting pulled.

      • Optionalquery?: { limit?: number; pagination_token?: string; reverse_order?: boolean }
        • Optionallimit?: number

          An integer limit on the number of log records returned.

        • Optionalpagination_token?: string

          A token used to iterate through pages of returned log records.

        • Optionalreverse_order?: boolean

          A flag to indicate if log records should be returned in reverse order.

    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/runs/{action_id}/resume": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string; run_id: string };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { flow_id: string; run_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            action_id: string;
                            completion_time: string;
                            details: Record<string, never>;
                            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";
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { flow_id: string; run_id: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { flow_id: string; run_id: string }
        • flow_id: string

          The ID for the Flow which launched the Run.

        • run_id: string

          The ID for the Run whose data is being resumed.

      • Optionalquery?: undefined
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { flow_id: string; run_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          action_id: string;
                          completion_time: string;
                          details: Record<string, never>;
                          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";
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Resume a Run

      Attempt to resume a Run, particularly when it has reached a status of INACTIVE. A Flow Run may reach an INACTIVE status when an Action type state within the Flow returns its status as INACTIVE. The resume operation on the Flow Run provides a hint that the cause of the Action becoming INACTIVE may have been cleared, and thus the resume operation on the Action Provider should be invoked to allow the Action state to resume and thus resume the Flow Run.

      In the particular case that an Action state is INACTIVE with a
      code value of "ConsentRequired" it is further assumed that the
      Bearer token provided in the Authorization header on the
      resume operation now carries sufficient consents to continue
      the INACTIVE Action. Thus, the Flow service will use the
      Bearer token to generate new dependent tokens for running the
      Action and use these tokens to request that the Action be
      resumed at the Action Provider.
      
      Note again that in reasons other than "ConsentRequired" for a
      Flow or Action to go INACTIVE, the resume operation is just a
      hint. For example, when the code is "ActivationRequired,"
      indicating that a Globus collection or endpoint needs to be
      Activated by the user, performing that Activation out-of-band
      from the Flow will allow the Flow to proceed even without the
      resume operation as the Action is periodically polled for
      progress. Performing the resume operation may simply cause a
      poll to happen more quickly and thus allow the Action to
      resume more quickly.
      
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { flow_id: string; run_id: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { flow_id: string; run_id: string }
          • flow_id: string

            The ID for the Flow which launched the Run.

          • run_id: string

            The ID for the Run whose data is being resumed.

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        action_id: string;
                        completion_time: string;
                        details: Record<string, never>;
                        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";
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      action_id: string;
                      completion_time: string;
                      details: Record<string, never>;
                      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";
                  };
              };
              headers: { [name: string]: unknown };
          }

          The request was successful.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The requested Run or Flow was not found. Or, the requestor did not have access to manage the Run.

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/runs/{run_id}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { run_id: string };
                query?: { include_flow_description?: boolean };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            action_id: string;
                            completion_time: string;
                            details: Record<string, never>;
                            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_description?: {
                                created_at: string;
                                deleted_at?: string;
                                description?: string;
                                flow_owner?: string;
                                id: string;
                                keywords?: (...)[];
                                subtitle?: string;
                                title: string;
                                updated_at?: string;
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": { content?: undefined; headers: { [name: string]: unknown } };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { run_id: string };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { run_id: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        label?: string;
                        run_managers?: string[];
                        run_monitors?: string[];
                        tags?: string[];
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            action_id: string;
                            completion_time: string;
                            details: Record<string, never>;
                            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";
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": { content?: undefined; headers: { [name: string]: unknown } };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
                "422": { content?: undefined; headers: { [name: string]: unknown } };
                "429": { content?: undefined; headers: { [name: string]: unknown } };
                "502": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { run_id: string };
              query?: { include_flow_description?: boolean };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          action_id: string;
                          completion_time: string;
                          details: Record<string, never>;
                          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_description?: {
                              created_at: string;
                              deleted_at?: string;
                              description?: string;
                              flow_owner?: string;
                              id: string;
                              keywords?: (...)[];
                              subtitle?: string;
                              title: string;
                              updated_at?: string;
                          };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": { content?: undefined; headers: { [name: string]: unknown } };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Get details about a run

      Get details about a run.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { run_id: string };
            query?: { include_flow_description?: boolean };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { run_id: string }
          • run_id: string

            The ID for the Run.

        • Optionalquery?: { include_flow_description?: boolean }
          • Optionalinclude_flow_description?: boolean

            If present and set to a true value, metadata about the associated flow will be included.

            true
            
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        action_id: string;
                        completion_time: string;
                        details: Record<string, never>;
                        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_description?: {
                            created_at: string;
                            deleted_at?: string;
                            description?: string;
                            flow_owner?: string;
                            id: string;
                            keywords?: (...)[];
                            subtitle?: string;
                            title: string;
                            updated_at?: string;
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": { content?: undefined; headers: { [name: string]: unknown } };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      action_id: string;
                      completion_time: string;
                      details: Record<string, never>;
                      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_description?: {
                          created_at: string;
                          deleted_at?: string;
                          description?: string;
                          flow_owner?: string;
                          id: string;
                          keywords?: (...)[];
                          subtitle?: string;
                          title: string;
                          updated_at?: string;
                      };
                  };
              };
              headers: { [name: string]: unknown };
          }

          The request was successfully received.

        • 403: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor presented a token with insufficient scopes.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The Run does not exist or the requestor did not have access to view the Run's status.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { run_id: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { run_id: string }
        • run_id: string

          The ID for the Run.

      • Optionalquery?: undefined
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • put: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { run_id: string };
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      label?: string;
                      run_managers?: string[];
                      run_monitors?: string[];
                      tags?: string[];
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          action_id: string;
                          completion_time: string;
                          details: Record<string, never>;
                          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";
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": { content?: undefined; headers: { [name: string]: unknown } };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
              "422": { content?: undefined; headers: { [name: string]: unknown } };
              "429": { content?: undefined; headers: { [name: string]: unknown } };
              "502": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Update a Run's metadata

      Modify a Run's metadata.

      By default only the Run initiator is able to modify a Run's metadata.
      Note that delegating manage access to a principal will allow them
      to further alter the principals with monitor and manage access.
      
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { run_id: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { run_id: string }
          • run_id: string

            The ID for the Run.

        • Optionalquery?: undefined
      • requestBody: {
            content: {
                "application/json": {
                    label?: string;
                    run_managers?: string[];
                    run_monitors?: string[];
                    tags?: string[];
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        action_id: string;
                        completion_time: string;
                        details: Record<string, never>;
                        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";
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": { content?: undefined; headers: { [name: string]: unknown } };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
            "422": { content?: undefined; headers: { [name: string]: unknown } };
            "429": { content?: undefined; headers: { [name: string]: unknown } };
            "502": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      action_id: string;
                      completion_time: string;
                      details: Record<string, never>;
                      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";
                  };
              };
              headers: { [name: string]: unknown };
          }

          The request was successfully received.

        • 403: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor presented a token with insufficient scopes.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The Run does not exist or the requestor did not have access to modify the Run.

        • 422: { content?: undefined; headers: { [name: string]: unknown } }

          The request's JSON body did not pass schema validation.

        • 429: { content?: undefined; headers: { [name: string]: unknown } }

          An upstream service has imposed rate limiting. The requestor may resubmit the API request.

        • 502: { content?: undefined; headers: { [name: string]: unknown } }

          An unknown upstream service error occurred. The problem may be resolved by re-submitting the API request.

    • Optionaltrace?: undefined
    "/runs/{run_id}/cancel": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { run_id: string };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { run_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "202": {
                    content: {
                        "application/json": {
                            action_id: string;
                            completion_time: string;
                            details: Record<string, never>;
                            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";
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
                "502": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { run_id: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { run_id: string }
        • run_id: string

          The ID for the Run to cancel.

      • Optionalquery?: undefined
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { run_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "202": {
                  content: {
                      "application/json": {
                          action_id: string;
                          completion_time: string;
                          details: Record<string, never>;
                          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";
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
              "502": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Cancel a Run

      Cancel the execution for a particular Run of a Flow.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { run_id: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { run_id: string }
          • run_id: string

            The ID for the Run to cancel.

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "202": {
                content: {
                    "application/json": {
                        action_id: string;
                        completion_time: string;
                        details: Record<string, never>;
                        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";
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
            "502": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 202: {
              content: {
                  "application/json": {
                      action_id: string;
                      completion_time: string;
                      details: Record<string, never>;
                      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";
                  };
              };
              headers: { [name: string]: unknown };
          }

          The request was successfully received.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The requested Run or Flow was not found. Or, the requestor did not have access to view the Run.

        • 502: { content?: undefined; headers: { [name: string]: unknown } }

          The service encountered an Upstream error when attempting to cancel the Run.

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/runs/{run_id}/definition": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { run_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            definition: Record<string, never>;
                            flow_id: string;
                            input_schema: Record<string, never>;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": { content?: undefined; headers: { [name: string]: unknown } };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { run_id: string };
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { run_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          definition: Record<string, never>;
                          flow_id: string;
                          input_schema: Record<string, never>;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": { content?: undefined; headers: { [name: string]: unknown } };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Get the Flow definition and input schema that were used to start a Run

      Flow definitions and input schemas may be updated after a Run has been started.

      This route allows users to view the Flow definition and input schema
      that were used to start a given Run.
      
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { run_id: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { run_id: string }
          • run_id: string

            The UUID of the Run.

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        definition: Record<string, never>;
                        flow_id: string;
                        input_schema: Record<string, never>;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": { content?: undefined; headers: { [name: string]: unknown } };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      definition: Record<string, never>;
                      flow_id: string;
                      input_schema: Record<string, never>;
                  };
              };
              headers: { [name: string]: unknown };
          }

          The request was successfully received.

        • 403: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor presented a token with insufficient scopes.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The Run does not exist or the requestor did not have access to view the Run.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { run_id: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { run_id: string }
        • run_id: string

          The UUID of the Run.

      • Optionalquery?: undefined
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/runs/{run_id}/release": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { run_id: string };
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { run_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            action_id: string;
                            completion_time: string;
                            details: Record<string, never>;
                            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";
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": { content?: undefined; headers: { [name: string]: unknown } };
                "404": { content?: undefined; headers: { [name: string]: unknown } };
                "409": { content?: undefined; headers: { [name: string]: unknown } };
                "429": { content?: undefined; headers: { [name: string]: unknown } };
                "500": { content?: undefined; headers: { [name: string]: unknown } };
                "502": { content?: undefined; headers: { [name: string]: unknown } };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: {
          cookie?: undefined;
          header?: undefined;
          path: { run_id: string };
          query?: undefined;
      }
      • Optionalcookie?: undefined
      • Optionalheader?: undefined
      • path: { run_id: string }
        • run_id: string

          The ID for the Run whose data is being released.

      • Optionalquery?: undefined
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { run_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          action_id: string;
                          completion_time: string;
                          details: Record<string, never>;
                          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";
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": { content?: undefined; headers: { [name: string]: unknown } };
              "404": { content?: undefined; headers: { [name: string]: unknown } };
              "409": { content?: undefined; headers: { [name: string]: unknown } };
              "429": { content?: undefined; headers: { [name: string]: unknown } };
              "500": { content?: undefined; headers: { [name: string]: unknown } };
              "502": { content?: undefined; headers: { [name: string]: unknown } };
          };
      }

      Remove a Run

      Remove the state for a particular invocation of a Flow.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { run_id: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { run_id: string }
          • run_id: string

            The ID for the Run whose data is being released.

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        action_id: string;
                        completion_time: string;
                        details: Record<string, never>;
                        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";
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": { content?: undefined; headers: { [name: string]: unknown } };
            "404": { content?: undefined; headers: { [name: string]: unknown } };
            "409": { content?: undefined; headers: { [name: string]: unknown } };
            "429": { content?: undefined; headers: { [name: string]: unknown } };
            "500": { content?: undefined; headers: { [name: string]: unknown } };
            "502": { content?: undefined; headers: { [name: string]: unknown } };
        }
        • 200: {
              content: {
                  "application/json": {
                      action_id: string;
                      completion_time: string;
                      details: Record<string, never>;
                      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";
                  };
              };
              headers: { [name: string]: unknown };
          }

          The request was successful.

        • 403: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor is not authorized to access the run or flow, or has not provided access tokens with sufficient privileges.

        • 404: { content?: undefined; headers: { [name: string]: unknown } }

          The requested Run or Flow was not found. Or, the requestor did not have access to view the Run.

        • 409: { content?: undefined; headers: { [name: string]: unknown } }

          The requestor attempted to remove the state for a Run which had not yet reached a completed status.

        • 429: { content?: undefined; headers: { [name: string]: unknown } }

          An upstream service rate-limited the request to release the Run. The requestor may re-submit the request at a later time.

        • 500: { content?: undefined; headers: { [name: string]: unknown } }

          The run is in an unexpected state in the Flows service. Please contact Globus support.

        • 502: { content?: undefined; headers: { [name: string]: unknown } }

          A request to an upstream service failed for an unknown reason. The requestor can re-submit the request or contact Globus support.

    • Optionalput?: undefined
    • Optionaltrace?: undefined