Globus SDK for JavaScript
    Preparing search index...

    Function run

    • Run an instance of a particular Flow.

      Parameters

      • flow_id: string
      • Optionaloptions: {
            payload: {
                activity_notification_policy?: {
                    status: ("SUCCEEDED" | "FAILED" | "INACTIVE")[];
                };
                body: { [key: string]: unknown };
                label?: string;
                run_managers?: string[];
                run_monitors?: string[];
                tags?: string[];
            };
            query?: undefined;
        } & {
            headers?: Headers;
            query?: {
                [key: string]: | undefined
                | null
                | string
                | number
                | boolean
                | (undefined | null | string | number)[];
            };
        }
      • OptionalsdkOptions: SDKOptions

      Returns Promise<
          JSONFetchResponse<
              {
                  action_id: string;
                  completion_time: string;
                  details: Record<string, unknown>;
                  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";
              },
          >,
      >

      https://globusonline.github.io/globus-flows/#tag/Runs/paths/~1flows~1{flow_id}~1run/post

    Settings

    Member Visibility