Globus SDK for JavaScript
    Preparing search index...

    Function update

    • Update a Run's metadata.

      Parameters

      • run_id: string
      • Optionaloptions: {
            payload?: {
                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/~1runs~1{run_id}/put

    Settings

    Member Visibility