Interface components

Type declaration

• Action: {
      ActionScope?: string;
      ActionUrl: string;
      Catch?: unknown;
      Comment?: unknown;
      End?: unknown;
      ExceptionOnActionFailure: boolean;
      InputPath?: unknown;
      Next?: unknown;
      Parameters?: unknown;
      ResultPath?: unknown;
      RunAs?: string;
      Type: string;
      WaitTime?: number;
  } & { End?: boolean; Next?: string } & { Parameters?: string } & {
      InputPath?: string;
  } & { ResultPath?: string } & {
      Catch?: (
          { ErrorEquals: string[]; Next: string; ResultPath?: unknown } & {
              ResultPath?: string;
          }
      )[];
  }

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

  Activity notification policy

  Description

  The email notification policy for the run.

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

    Description

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

    Default

    [
          "INACTIVE"
        ]
    Copy

• BatchRunUpdateOperation: { run_managers?: string[]; run_monitors?: string[]; tags?: string[] }

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

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

• Choice: {
      Choices: (
          { Next?: string } & {
              And?: (
                  { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
              )[];
              BooleanEquals?: boolean;
              BooleanEqualsPath?: string;
              IsBoolean?: boolean;
              IsNull?: boolean;
              IsNumeric?: boolean;
              IsPresent?: boolean;
              IsString?: boolean;
              IsTimestamp?: boolean;
              Not?: { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; };
              NumericEquals?: number;
              NumericEqualsPath?: string;
              NumericGreaterThan?: number;
              NumericGreaterThanEquals?: number;
              NumericGreaterThanEqualsPath?: string;
              NumericGreaterThanPath?: string;
              NumericLessThan?: number;
              NumericLessThanEquals?: number;
              NumericLessThanEqualsPath?: string;
              NumericLessThanPath?: string;
              Or?: (
                  { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
              )[];
              StringEquals?: string;
              StringEqualsPath?: string;
              StringGreaterThan?: string;
              StringGreaterThanEquals?: string;
              StringGreaterThanEqualsPath?: string;
              StringGreaterThanPath?: string;
              StringLessThan?: string;
              StringLessThanEquals?: string;
              StringLessThanEqualsPath?: string;
              StringLessThanPath?: string;
              StringMatches?: string;
              TimestampEquals?: string;
              TimestampEqualsPath?: string;
              TimestampGreaterThan?: string;
              TimestampGreaterThanEquals?: string;
              TimestampGreaterThanEqualsPath?: string;
              TimestampGreaterThanPath?: string;
              TimestampLessThan?: string;
              TimestampLessThanEquals?: string;
              TimestampLessThanEqualsPath?: string;
              TimestampLessThanPath?: string;
              Variable?: string;
          }
      )[];
      Comment?: string;
      Default?: string;
      Type?: string;
  }

• ChoiceRule: {
      And?: (
          { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
      )[];
      BooleanEquals?: boolean;
      BooleanEqualsPath?: string;
      IsBoolean?: boolean;
      IsNull?: boolean;
      IsNumeric?: boolean;
      IsPresent?: boolean;
      IsString?: boolean;
      IsTimestamp?: boolean;
      Not?: { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; };
      NumericEquals?: number;
      NumericEqualsPath?: string;
      NumericGreaterThan?: number;
      NumericGreaterThanEquals?: number;
      NumericGreaterThanEqualsPath?: string;
      NumericGreaterThanPath?: string;
      NumericLessThan?: number;
      NumericLessThanEquals?: number;
      NumericLessThanEqualsPath?: string;
      NumericLessThanPath?: string;
      Or?: (
          { And?: ...[] | undefined; Or?: ...[] | undefined; Not?: ... | undefined; Variable?: string | undefined; StringEquals?: string | undefined; StringEqualsPath?: string | undefined; StringLessThan?: string | undefined; ... 35 more ...; IsTimestamp?: boolean | undefined; }
      )[];
      StringEquals?: string;
      StringEqualsPath?: string;
      StringGreaterThan?: string;
      StringGreaterThanEquals?: string;
      StringGreaterThanEqualsPath?: string;
      StringGreaterThanPath?: string;
      StringLessThan?: string;
      StringLessThanEquals?: string;
      StringLessThanEqualsPath?: string;
      StringLessThanPath?: string;
      StringMatches?: string;
      TimestampEquals?: string;
      TimestampEqualsPath?: string;
      TimestampGreaterThan?: string;
      TimestampGreaterThanEquals?: string;
      TimestampGreaterThanEqualsPath?: string;
      TimestampGreaterThanPath?: string;
      TimestampLessThan?: string;
      TimestampLessThanEquals?: string;
      TimestampLessThanEqualsPath?: string;
      TimestampLessThanPath?: string;
      Variable?: string;
  }

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

  • OptionalBooleanEquals?: boolean

  • OptionalBooleanEqualsPath?: string

  • OptionalIsBoolean?: boolean

  • OptionalIsNull?: boolean

  • OptionalIsNumeric?: boolean

  • OptionalIsPresent?: boolean

  • OptionalIsString?: boolean

  • OptionalIsTimestamp?: boolean

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

  • OptionalNumericEquals?: number

  • OptionalNumericEqualsPath?: string

  • OptionalNumericGreaterThan?: number

  • OptionalNumericGreaterThanEquals?: number

  • OptionalNumericGreaterThanEqualsPath?: string

  • OptionalNumericGreaterThanPath?: string

  • OptionalNumericLessThan?: number

  • OptionalNumericLessThanEquals?: number

  • OptionalNumericLessThanEqualsPath?: string

  • OptionalNumericLessThanPath?: string

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

  • OptionalStringEquals?: string

  • OptionalStringEqualsPath?: string

  • OptionalStringGreaterThan?: string

  • OptionalStringGreaterThanEquals?: string

  • OptionalStringGreaterThanEqualsPath?: string

  • OptionalStringGreaterThanPath?: string

  • OptionalStringLessThan?: string

  • OptionalStringLessThanEquals?: string

  • OptionalStringLessThanEqualsPath?: string

  • OptionalStringLessThanPath?: string

  • OptionalStringMatches?: string

  • OptionalTimestampEquals?: string

    Format: date-time

  • OptionalTimestampEqualsPath?: string

  • OptionalTimestampGreaterThan?: string

    Format: date-time

  • OptionalTimestampGreaterThanEquals?: string

    Format: date-time

  • OptionalTimestampGreaterThanEqualsPath?: string

  • OptionalTimestampGreaterThanPath?: string

  • OptionalTimestampLessThan?: string

    Format: date-time

  • OptionalTimestampLessThanEquals?: string

    Format: date-time

  • OptionalTimestampLessThanEqualsPath?: string

  • OptionalTimestampLessThanPath?: string

  • OptionalVariable?: string

• ExpressionEval: {
      Comment?: unknown;
      Next: string;
      Parameters: unknown;
      ResultPath: unknown;
      Type?: string;
  } & { Parameters?: string } & { ResultPath?: string }

• Fail: { Cause?: string; Comment?: string; Error?: string; Type?: string }

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

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

  • created_at: string

    Format: date-time

    Description

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

  • Optionaldeleted_at?: string

    Format: date-time

    Description

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

  • Optionaldescription?: string

    Description

    A detailed description of the Flow for end user display.

  • Optionalflow_owner?: string

    Description

    The user with primary responsibility for the Flow.

  • id: string

    Description

    The unique identifier for the Flow.

  • Optionalkeywords?: string[]

    Description

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

  • Optionalsubtitle?: string

    Description

    A concise summary of the Flow's purpose.

  • title: string

    Description

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

  • Optionalupdated_at?: string

    Format: date-time

    Description

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

• FlowResponse: {
      api_version?: "1.0";
      created_at?: string;
      definition?: {
          Comment?: string;
          StartAt: string;
          States: {
              [key: string]:
                  | {
                      Comment?: unknown;
                      End?: unknown;
                      InputPath?: unknown;
                      Next?: unknown;
                      Parameters?: unknown;
                      ResultPath?: unknown;
                      Type?: string;
                  } & { End?: boolean; Next?: string } & { Parameters?: string } & {
                      InputPath?: string;
                  } & { ResultPath?: string }
                  | {
                      ActionScope?: string;
                      ActionUrl: string;
                      Catch?: unknown;
                      Comment?: unknown;
                      End?: unknown;
                      ExceptionOnActionFailure: boolean;
                      InputPath?: unknown;
                      Next?: unknown;
                      Parameters?: unknown;
                      ResultPath?: unknown;
                      RunAs?: string;
                      Type: string;
                      WaitTime?: number;
                  } & { End?: boolean; Next?: string } & { Parameters?: string } & {
                      InputPath?: string;
                  } & { ResultPath?: string } & { Catch?: ((...) & (...))[] }
                  | {
                      Comment?: unknown;
                      Next?: string;
                      Seconds?: number;
                      SecondsPath?: string;
                      Timestamp?: string;
                      TimestampPath?: string;
                      Type?: string;
                  }
                  | {
                      Choices: (
                          { Next?: (...)
                          | (...) } & {
                              And?: (...) | (...);
                              BooleanEquals?: (...) | (...) | (...);
                              BooleanEqualsPath?: (...) | (...);
                              IsBoolean?: (...) | (...) | (...);
                              IsNull?: (...) | (...) | (...);
                              IsNumeric?: (...) | (...) | (...);
                              IsPresent?: (...) | (...) | (...);
                              IsString?: (...) | (...) | (...);
                              IsTimestamp?: (...) | (...) | (...);
                              Not?: (...) | (...);
                              NumericEquals?: (...) | (...);
                              NumericEqualsPath?: (...) | (...);
                              NumericGreaterThan?: (...) | (...);
                              NumericGreaterThanEquals?: (...) | (...);
                              NumericGreaterThanEqualsPath?: (...) | (...);
                              NumericGreaterThanPath?: (...) | (...);
                              NumericLessThan?: (...) | (...);
                              NumericLessThanEquals?: (...) | (...);
                              NumericLessThanEqualsPath?: (...) | (...);
                              NumericLessThanPath?: (...) | (...);
                              Or?: (...) | (...);
                              StringEquals?: (...) | (...);
                              StringEqualsPath?: (...) | (...);
                              StringGreaterThan?: (...) | (...);
                              StringGreaterThanEquals?: (...) | (...);
                              StringGreaterThanEqualsPath?: (...) | (...);
                              StringGreaterThanPath?: (...) | (...);
                              StringLessThan?: (...) | (...);
                              StringLessThanEquals?: (...) | (...);
                              StringLessThanEqualsPath?: (...) | (...);
                              StringLessThanPath?: (...) | (...);
                              StringMatches?: (...) | (...);
                              TimestampEquals?: (...) | (...);
                              TimestampEqualsPath?: (...) | (...);
                              TimestampGreaterThan?: (...) | (...);
                              TimestampGreaterThanEquals?: (...) | (...);
                              TimestampGreaterThanEqualsPath?: (...) | (...);
                              TimestampGreaterThanPath?: (...) | (...);
                              TimestampLessThan?: (...) | (...);
                              TimestampLessThanEquals?: (...) | (...);
                              TimestampLessThanEqualsPath?: (...) | (...);
                              TimestampLessThanPath?: (...) | (...);
                              Variable?: (...) | (...);
                          }
                      )[];
                      Comment?: string;
                      Default?: string;
                      Type?: string;
                  }
                  | {
                      Comment?: unknown;
                      Next: string;
                      Parameters: unknown;
                      ResultPath: unknown;
                      Type?: string;
                  } & { Parameters?: string } & { ResultPath?: string }
                  | { Cause?: string; Comment?: string; Error?: string; Type?: string };
          };
      };
      description?: string;
      flow_administrators?: string[];
      flow_owner?: string;
      flow_starters?: string[];
      flow_url?: string;
      flow_viewers?: string[];
      globus_auth_scope?: string;
      globus_auth_scopes_by_RunAs?: string[];
      globus_auth_username?: string;
      id?: string;
      input_schema?: Record<string, 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";
  }

  • Optionalapi_version?: "1.0"

  • Optionalcreated_at?: string

    Format: date-time

    Description

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

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

    Description

    The Flow to deploy.

  • Optionaldescription?: string

    Description

    A detailed description of the Flow for end user display.

  • Optionalflow_administrators?: string[]

    Description

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

  • Optionalflow_owner?: string

    Description

    The user with primary responsibility for the Flow.

  • Optionalflow_starters?: string[]

    Description

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

    Example

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

  • Optionalflow_url?: string

    Format: uri

    Description

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

  • Optionalflow_viewers?: string[]

    Description

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

    Example

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

  • Optionalglobus_auth_scope?: string

    Format: uri

    Description

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

  • Optionalglobus_auth_scopes_by_RunAs?: string[]

    Description

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

  • Optionalglobus_auth_username?: string

    Description

    The Flow's Globus Auth username.

  • Optionalid?: string

    Description

    The unique identifier for the Flow.

  • Optionalinput_schema?: Record<string, never>

    Description

    A JSON Schema compliant definition of the format of the body field when requesting a Flow be run.

  • Optionalkeywords?: string[]

    Description

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

  • Optionallog_supported?: boolean

    Description

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

  • Optionalprincipal_urn?: string

    Description

    The Flow's identity in Globus Auth.

  • Optionalsubscription_id?: string

    Format: uuid

    Description

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

  • Optionalsubtitle?: string

    Description

    A concise summary of the Flow's purpose.

  • Optionalsynchronous?: boolean

  • Optionaltitle?: string

    Description

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

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

  • Optionalupdated_at?: string

    Format: date-time

    Description

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

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

    Description

    The role the requesting user has on the Flow.

• FlowRun: {
      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";
  }

  • action_id: string

    Description

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

  • completion_time: string

    Format: date-time

    Description

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

  • details: Record<string, never>

  • Optionaldisplay_status?: string

  • flow_id: string

    Description

    The Flow to which this Run belongs.

  • flow_last_updated: string

    Format: date-time

    Description

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

  • label: string

  • run_id: string

    Description

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

  • Optionalrun_managers?: string[]

  • Optionalrun_monitors?: string[]

  • run_owner: string

  • start_time: string

    Format: date-time

    Description

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

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

    Description

    The current state of the Run.

  • tags: string[]

  • user_role: "run_manager" | "run_monitor" | "run_owner"

    Description

    The role the requesting user has on the Run.

• FlowRunWithFlowEmbed: {
      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?: string[];
          subtitle?: string;
          title: string;
          updated_at?: string;
      };
  }

• FlowScopes: { [key: string]: string[] }

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

  • debug_id: string

    Description

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

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

    • code: string

      Description

      A readable keyword describing the failure.

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

      An array of failure objects, describing what failed.

    • Optionalmessage?: string

      Description

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

• FlowValidationResponse: { scopes?: { [key: string]: string[] } }

  • Optionalscopes?: { [key: string]: string[] }

    Description

    A mapping of RunAs values to the scopes required to run the flow as that identity.

• GetRunDefinitionResponse: {
      definition: Record<string, never>;
      flow_id: string;
      input_schema: Record<string, never>;
  }

  • definition: Record<string, never>

    Description

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

  • flow_id: string

    Description

    The Flow used to start the Run.

  • input_schema: Record<string, never>

    Description

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

• HTTP202Response: unknown

  Description

  The requested operation was accepted.

  The operation may have been completed, or may be completed at a later time.
  A follow-up API request may be needed to confirm the status of the operation.
  

• HTTP403Response: unknown

  Description

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

• HTTP422Response: unknown

  Description

  The input document failed input validation in some way.

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

  Input body

  Description

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

• InputPath: { InputPath?: string }

• JsonPathPattern: string

• Label: string

  Label

  Description

  A short, human-readable description of the run.

  Example

  Generate a report for experiment xDA202-batch-3
  Copy

• LocationErrorList: { loc: string[]; msg: string; type: string }[]

• NextOrEnd: { End?: boolean; Next?: string }

• Parameters: { Parameters?: string }

• ParametersOrInputPath: { Parameters?: string } & { InputPath?: string }

• ParametersOrInputPathNotRequired: { Parameters?: string } & { InputPath?: string }

• Pass: {
      Comment?: unknown;
      End?: unknown;
      InputPath?: unknown;
      Next?: unknown;
      Parameters?: unknown;
      ResultPath?: unknown;
      Type?: string;
  } & { End?: boolean; Next?: string } & { Parameters?: string } & {
      InputPath?: string;
  } & { ResultPath?: string }

• PrincipalURN: string

  Description

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

  Example

  urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c
  Copy

• PrincipalURN_or_all_authenticated_users: string

  Description

  A URN representation of an Identity in Globus either of a user from Globus Auth or a group from Globus Groups or the special value "all_authenticated_users" indicating any user who presents valid credentials (bearer token).

  Example

  all_authenticated_users
  Copy

• PrincipalURN_or_public: string

  Description

  A URN representation of an Identity in Globus either of a user from Globus Auth or a group from Globus Groups or the special value "public".

  Example

  urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035
  Copy

• ResultPath: { ResultPath?: string }

• RunManagers: string[]

  Run managers

  Description

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

  "Managing" operations include updating, canceling, and deleting the run.
  
  Only users with the "run_manager" role will be able to view this list.
  Users with only the "run_monitor" role will see an empty list.
  

• RunMonitors: string[]

  Run monitors

  Description

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

  "Monitoring" operations include checking the run status and its logs.
  
  Only users with the "run_manager" role will be able to view this list.
  Users with only the "run_monitor" role will see an empty list.
  

• RunUpdate: {
      label?: string;
      run_managers?: string[];
      run_monitors?: string[];
      tags?: string[];
  }

• Tags: string[]

  Tags

  Description

  A list of tags to associate with the run.

  Tags are normalized by stripping leading and trailing whitespace,
  and by replacing all whitespace with a single space.
  
  When updating a run, existing tags will be overwritten.
  This means that an empty array will delete all existing tags.
  

  Example

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

• ValidateRun: { message: string }

  • message: string

    Description

    A message indicating the validation was successful

    Example

    success
    Copy

• Wait: {
      Comment?: unknown;
      Next?: string;
      Seconds?: number;
      SecondsPath?: string;
      Timestamp?: string;
      TimestampPath?: string;
      Type?: string;
  }

  • OptionalComment?: unknown

  • OptionalNext?: string

  • OptionalSeconds?: number

  • OptionalSecondsPath?: string

  • OptionalTimestamp?: string

    Format: date-time

  • OptionalTimestampPath?: string

  • OptionalType?: string