Interface components

Type Declaration

• ApiTimerActivityAwaiting: { code: "awaiting_next_run"; next_run: string }

  ApiTimerActivityAwaiting

  Description

  A timer activity describing when a timer is waiting for the next scheduled run.

  • code: "awaiting_next_run"

    Code

    Default

    awaiting_next_run
    @enum {string}
    Copy

  • next_run: string

    Next Run Format: date-time

• ApiTimerActivityInProgress: { code: "run_in_progress"; duration_seconds: number; start_timestamp: string }

  ApiTimerActivityInProgress

  Description

  A timer activity describing when a timer is currently waiting for a run to complete.

  • code: "run_in_progress"

    Code

    Default

    run_in_progress
    @enum {string}
    Copy

  • duration_seconds: number

    Duration Seconds

  • start_timestamp: string

    Start Timestamp Format: date-time

• ApiTimerActivityPaused: { code: "paused"; reason: "other" | "user" | "globus_auth_requirements" }

  ApiTimerActivityPaused

  Description

  A timer activity describing when a timer is paused.

  • code: "paused"

    Code

    Default

    paused
    @enum {string}
    Copy

  • reason: "other" | "user" | "globus_auth_requirements"

    Reason

• ApiTimerActivityRetrying: { code: "retrying"; start_timestamp: string }

  ApiTimerActivityRetrying

  Description

  A timer activity describing when a timer is currently retrying the scheduled run.

  • code: "retrying"

    Code

    Default

    retrying
    @enum {string}
    Copy

  • start_timestamp: string

    Start Timestamp Format: date-time

• EndConditionIterations: { condition: "iterations"; count: number }

  EndConditionIterations

  Description

  The condition for a timer which stops running after a number of calls.

  • condition: "iterations"

    Condition

    Default

    iterations
    @enum {string}
    Copy

  • count: number

    Count

• EndConditionTime: { condition: "time"; datetime: string }

  EndConditionTime

  Description

  The end condition for a timer which stops running after a time.

  • condition: "time"

    Condition

    Default

    time
    @enum {string}
    Copy

  • datetime: string

    Datetime Format: date-time

• FilterRule: {
      DATA_TYPE: "filter_rule";
      method: "include" | "exclude";
      name: string;
      type?: "file" | "dir";
  }

  FilterRule

  • DATA_TYPE: "filter_rule"

    Data Type

    Default

    filter_rule
    @enum {string}
    Copy

  • method: "include" | "exclude"

    Method

    Default

    exclude
    @enum {string}
    Copy

  • name: string

    Name

  • Optionaltype?: "file" | "dir"

    Type

• FlowStartDocument: {
      body: Record<string, unknown>;
      run_managers?: string[];
      run_monitors?: string[];
      tags?: string[];
  }

  FlowStartDocument

  • body: Record<string, unknown>

    Body

    Description

    Input variables to pass to the flow each time it is started.

  • Optionalrun_managers?: string[]

    Run Managers

    Description

    Principals (identities or groups) which are allowed to manage each run.

  • Optionalrun_monitors?: string[]

    Run Monitors

    Description

    Principals (identities or groups) which are allowed to monitor each run.

  • Optionaltags?: string[]

    Tags

    Description

    Tags that will be added to each run.

• FlowTimerRead: {
      activity?:
          | { code: "awaiting_next_run"; next_run: string }
          | {
              code: "run_in_progress";
              duration_seconds: number;
              start_timestamp: string;
          }
          | {
              code: "paused";
              reason: "other"
              | "user"
              | "globus_auth_requirements";
          }
          | { code: "retrying"; start_timestamp: string };
      callback_body: Record<string, unknown>;
      callback_url: string;
      flow_id: string;
      inactive_reason?: {
          cause: "user" | "globus_auth_requirements";
          detail?: Record<string, unknown>;
      };
      interval?: number;
      job_id: string;
      last_ran_at?: string;
      n_errors: number;
      n_runs: number;
      name?: string;
      next_run?: string;
      results: {
          data: {
              data?: Record<string, unknown>;
              end_timestamp?: string;
              errors?: Record<string, unknown>;
              http_status_polled?: number;
              http_status_submission?: number;
              last_check_timestamp?: string;
              next_check_timestamp?: string;
              ran_at: string;
              resource_id?: string;
              run_status: string;
              start_timestamp: string;
              status?: number;
          }[];
          page_next?: string;
      };
      schedule: | { datetime?: string; type: "once" }
      | {
          end?:
              | { condition: "iterations"; count: number }
              | { condition: "time"; datetime: string };
          interval_seconds: number;
          start?: string;
          type: "recurring";
      };
      scope?: string;
      start: string;
      status: string;
      stop_after: { date?: string; n_runs?: number };
      submitted_at: string;
      timer_type: "transfer" | "generic" | "flow";
  }

  FlowTimerRead

  • Optionalactivity?:
        | { code: "awaiting_next_run"; next_run: string }
        | {
            code: "run_in_progress";
            duration_seconds: number;
            start_timestamp: string;
        }
        | { code: "paused"; reason: "other"
        | "user"
        | "globus_auth_requirements" }
        | { code: "retrying"; start_timestamp: string }

    Activity

  • callback_body: Record<string, unknown>

    Callback Body

    Example

    {
                 *       "request_id": "a403b459-376e-47a2-a55d-30e7ddbcc3d2",
                 *       "body": {
                 *         "source_endpoint_id": "just_an_example"
                 *       }
                 *     }
    Copy

  • callback_url: string

    Callback Url Format: uri

    Example

    [
          "https://actions.automate.globus.org/transfer/transfer/run"
        ]
    Copy

  • flow_id: string

    Flow Id Format: uuid

  • Optionalinactive_reason?: { cause: "user" | "globus_auth_requirements"; detail?: Record<string, unknown> }

    • cause: "user" | "globus_auth_requirements"

      Cause

    • Optionaldetail?: Record<string, unknown>

      Detail

  • Optionalinterval?: number

    Interval Format: time-delta

  • job_id: string

    Job Id Format: uuid

  • Optionallast_ran_at?: string

    Last Ran At Format: date-time

  • n_errors: number

    N Errors

  • n_runs: number

    N Runs

  • Optionalname?: string

    Name

  • Optionalnext_run?: string

    Next Run Format: date-time

  • results: {
        data: {
            data?: Record<string, unknown>;
            end_timestamp?: string;
            errors?: Record<string, unknown>;
            http_status_polled?: number;
            http_status_submission?: number;
            last_check_timestamp?: string;
            next_check_timestamp?: string;
            ran_at: string;
            resource_id?: string;
            run_status: string;
            start_timestamp: string;
            status?: number;
        }[];
        page_next?: string;
    }

    • data: {
          data?: Record<string, unknown>;
          end_timestamp?: string;
          errors?: Record<string, unknown>;
          http_status_polled?: number;
          http_status_submission?: number;
          last_check_timestamp?: string;
          next_check_timestamp?: string;
          ran_at: string;
          resource_id?: string;
          run_status: string;
          start_timestamp: string;
          status?: number;
      }[]

      Data

    • Optionalpage_next?: string

      Page Next

  • schedule:
        | { datetime?: string; type: "once" }
        | {
            end?:
                | { condition: "iterations"; count: number }
                | { condition: "time"; datetime: string };
            interval_seconds: number;
            start?: string;
            type: "recurring";
        }

    Schedule

  • Optionalscope?: string

    Scope

    Example

    https://auth.globus.org/scopes/actions.globus.org/transfer/transfer
    Copy

  • start: string

    Start Format: date-time

  • status: string

    Status

  • stop_after: { date?: string; n_runs?: number }

    • Optionaldate?: string

      Date Format: date-time

    • Optionaln_runs?: number

      N Runs

  • submitted_at: string

    Submitted At Format: date-time

  • timer_type: "transfer" | "generic" | "flow"

• HTTPValidationError: { detail?: { loc: (string | number)[]; msg: string; type: string }[] }

  HTTPValidationError

  • Optionaldetail?: { loc: (string | number)[]; msg: string; type: string }[]

    Detail

• JobCreate: {
      callback_body: Record<string, unknown>;
      callback_url: string;
      interval?: number;
      name?: string;
      refresh_token?: string;
      scope?: string;
      start: string;
      stop_after?: string | { date?: string; n_runs?: number };
      stop_after_n?: number;
  }

  JobCreate

  • callback_body: Record<string, unknown>

    Callback Body

    Example

    {
                 *       "request_id": "a403b459-376e-47a2-a55d-30e7ddbcc3d2",
                 *       "body": {
                 *         "source_endpoint_id": "just_an_example"
                 *       }
                 *     }
    Copy

  • callback_url: string

    Callback Url Format: uri

    Example

    [
          "https://actions.automate.globus.org/transfer/transfer/run"
        ]
    Copy

  • Optionalinterval?: number

    Interval Format: time-delta

  • Optionalname?: string

    Name

  • Optionalrefresh_token?: string

    Refresh Token

  • Optionalscope?: string

    Scope

    Example

    https://auth.globus.org/scopes/actions.globus.org/transfer/transfer
    Copy

  • start: string

    Start Format: date-time

  • Optionalstop_after?: string | { date?: string; n_runs?: number }

    Stop After

  • Optionalstop_after_n?: number

    Stop After N

• JobInactiveReason: { cause: "user" | "globus_auth_requirements"; detail?: Record<string, unknown> }

  JobInactiveReason

  • cause: "user" | "globus_auth_requirements"

    Cause

  • Optionaldetail?: Record<string, unknown>

    Detail

• JobRead: {
      activity?:
          | { code: "awaiting_next_run"; next_run: string }
          | {
              code: "run_in_progress";
              duration_seconds: number;
              start_timestamp: string;
          }
          | {
              code: "paused";
              reason: "other"
              | "user"
              | "globus_auth_requirements";
          }
          | { code: "retrying"; start_timestamp: string };
      callback_body: Record<string, unknown>;
      callback_url: string;
      inactive_reason?: {
          cause: "user" | "globus_auth_requirements";
          detail?: Record<string, unknown>;
      };
      interval?: number;
      job_id: string;
      last_ran_at?: string;
      n_errors: number;
      n_runs: number;
      name?: string;
      next_run?: string;
      results: {
          data: {
              data?: Record<string, unknown>;
              end_timestamp?: string;
              errors?: Record<string, unknown>;
              http_status_polled?: number;
              http_status_submission?: number;
              last_check_timestamp?: string;
              next_check_timestamp?: string;
              ran_at: string;
              resource_id?: string;
              run_status: string;
              start_timestamp: string;
              status?: number;
          }[];
          page_next?: string;
      };
      schedule: | { datetime?: string; type: "once" }
      | {
          end?:
              | { condition: "iterations"; count: number }
              | { condition: "time"; datetime: string };
          interval_seconds: number;
          start?: string;
          type: "recurring";
      };
      scope?: string;
      start: string;
      status: string;
      stop_after: { date?: string; n_runs?: number };
      submitted_at: string;
      timer_type: "transfer" | "generic" | "flow";
  }

  JobRead

  • Optionalactivity?:
        | { code: "awaiting_next_run"; next_run: string }
        | {
            code: "run_in_progress";
            duration_seconds: number;
            start_timestamp: string;
        }
        | { code: "paused"; reason: "other"
        | "user"
        | "globus_auth_requirements" }
        | { code: "retrying"; start_timestamp: string }

    Activity

  • callback_body: Record<string, unknown>

    Callback Body

    Example

    {
                 *       "request_id": "a403b459-376e-47a2-a55d-30e7ddbcc3d2",
                 *       "body": {
                 *         "source_endpoint_id": "just_an_example"
                 *       }
                 *     }
    Copy

  • callback_url: string

    Callback Url Format: uri

    Example

    [
          "https://actions.automate.globus.org/transfer/transfer/run"
        ]
    Copy

  • Optionalinactive_reason?: { cause: "user" | "globus_auth_requirements"; detail?: Record<string, unknown> }

    • cause: "user" | "globus_auth_requirements"

      Cause

    • Optionaldetail?: Record<string, unknown>

      Detail

  • Optionalinterval?: number

    Interval Format: time-delta

  • job_id: string

    Job Id Format: uuid

  • Optionallast_ran_at?: string

    Last Ran At Format: date-time

  • n_errors: number

    N Errors

  • n_runs: number

    N Runs

  • Optionalname?: string

    Name

  • Optionalnext_run?: string

    Next Run Format: date-time

  • results: {
        data: {
            data?: Record<string, unknown>;
            end_timestamp?: string;
            errors?: Record<string, unknown>;
            http_status_polled?: number;
            http_status_submission?: number;
            last_check_timestamp?: string;
            next_check_timestamp?: string;
            ran_at: string;
            resource_id?: string;
            run_status: string;
            start_timestamp: string;
            status?: number;
        }[];
        page_next?: string;
    }

    • data: {
          data?: Record<string, unknown>;
          end_timestamp?: string;
          errors?: Record<string, unknown>;
          http_status_polled?: number;
          http_status_submission?: number;
          last_check_timestamp?: string;
          next_check_timestamp?: string;
          ran_at: string;
          resource_id?: string;
          run_status: string;
          start_timestamp: string;
          status?: number;
      }[]

      Data

    • Optionalpage_next?: string

      Page Next

  • schedule:
        | { datetime?: string; type: "once" }
        | {
            end?:
                | { condition: "iterations"; count: number }
                | { condition: "time"; datetime: string };
            interval_seconds: number;
            start?: string;
            type: "recurring";
        }

    Schedule

  • Optionalscope?: string

    Scope

    Example

    https://auth.globus.org/scopes/actions.globus.org/transfer/transfer
    Copy

  • start: string

    Start Format: date-time

  • status: string

    Status

  • stop_after: { date?: string; n_runs?: number }

    • Optionaldate?: string

      Date Format: date-time

    • Optionaln_runs?: number

      N Runs

  • submitted_at: string

    Submitted At Format: date-time

  • timer_type: "transfer" | "generic" | "flow"

• JobResult: {
      data?: Record<string, unknown>;
      end_timestamp?: string;
      errors?: Record<string, unknown>;
      http_status_polled?: number;
      http_status_submission?: number;
      last_check_timestamp?: string;
      next_check_timestamp?: string;
      ran_at: string;
      resource_id?: string;
      run_status: string;
      start_timestamp: string;
      status?: number;
  }

  JobResult

  • Optionaldata?: Record<string, unknown>

    Data

  • Optionalend_timestamp?: string

    End Timestamp Format: date-time

  • Optionalerrors?: Record<string, unknown>

    Errors

  • Optionalhttp_status_polled?: number

    Http Status Polled

  • Optionalhttp_status_submission?: number

    Http Status Submission

  • Optionallast_check_timestamp?: string

    Last Check Timestamp Format: date-time

  • Optionalnext_check_timestamp?: string

    Next Check Timestamp Format: date-time

  • ran_at: string

    Ran At Format: date-time

  • Optionalresource_id?: string

    Resource Id

  • run_status: string

    Run Status

  • start_timestamp: string

    Start Timestamp Format: date-time

  • Optionalstatus?: number

    Status

• JobResultPage: {
      data: {
          data?: Record<string, unknown>;
          end_timestamp?: string;
          errors?: Record<string, unknown>;
          http_status_polled?: number;
          http_status_submission?: number;
          last_check_timestamp?: string;
          next_check_timestamp?: string;
          ran_at: string;
          resource_id?: string;
          run_status: string;
          start_timestamp: string;
          status?: number;
      }[];
      page_next?: string;
  }

  JobResultPage

  • data: {
        data?: Record<string, unknown>;
        end_timestamp?: string;
        errors?: Record<string, unknown>;
        http_status_polled?: number;
        http_status_submission?: number;
        last_check_timestamp?: string;
        next_check_timestamp?: string;
        ran_at: string;
        resource_id?: string;
        run_status: string;
        start_timestamp: string;
        status?: number;
    }[]

    Data

  • Optionalpage_next?: string

    Page Next

• JobResumeBehavior: { action: "run_once_immediately" | "wait_for_next_scheduled" }

  JobResumeBehavior

  • action: "run_once_immediately" | "wait_for_next_scheduled"

    Action

• JobUpdate: { name?: string }

  JobUpdate

  • Optionalname?: string

    Name

• MessageResponse: { message: string }

  MessageResponse

  • message: string

    Message

• OnceSchedule: { datetime?: string; type: "once" }

  OnceSchedule

  Description

  The schedule for a timer which runs once at a specific time.

  • Optionaldatetime?: string

    When to run the timer Format: date-time

    Description

    The time at which the timer should run. This must be provided as a time in the future or close to the current time.

  • type: "once"

    Description

    discriminator enum property added by openapi-typescript

• RecurringSchedule: {
      end?:
          | { condition: "iterations"; count: number }
          | { condition: "time"; datetime: string };
      interval_seconds: number;
      start?: string;
      type: "recurring";
  }

  RecurringSchedule

  Description

  The schedule for a timer which repeats until an end condition is met, or indefinitely if there is no end condition.

  • Optionalend?:
        | { condition: "iterations"; count: number }
        | { condition: "time"; datetime: string }

    End

  • interval_seconds: number

    The interval on which the timer runs.

    Description

    The number of seconds between runs of the timer.

  • Optionalstart?: string

    When to start the timer Format: date-time

    Description

    The time at which the timer should start running. This must be provided as a time in the future or close to the current time.

  • type: "recurring"

    Description

    discriminator enum property added by openapi-typescript

• StopAfter: { date?: string; n_runs?: number }

  StopAfter

  • Optionaldate?: string

    Date Format: date-time

  • Optionaln_runs?: number

    N Runs

• SupportedTimerType: "transfer" | "generic" | "flow"

  SupportedTimerType

  Description

  Supported values for the timer_type of a Timer.

  As Timers are modeled under the name `Job`, this is `Job.timer_type`.
  

• TransferTaskDocument: {
      DATA: {
          checksum_algorithm?: string;
          DATA_TYPE: "transfer_item";
          destination_path: string;
          external_checksum?: string;
          recursive?: boolean;
          source_path: string;
      }[];
      DATA_TYPE: "transfer";
      deadline?: string;
      delete_destination_extra: boolean;
      destination_endpoint: string;
      destination_local_user?: string;
      encrypt_data: boolean;
      fail_on_quota_errors: boolean;
      filter_rules?: {
          DATA_TYPE: "filter_rule";
          method: "include"
          | "exclude";
          name: string;
          type?: "file" | "dir";
      }[];
      label?: string;
      notify_on_failed: boolean;
      notify_on_inactive: boolean;
      notify_on_succeeded: boolean;
      preserve_timestamp: boolean;
      skip_source_errors: boolean;
      source_endpoint: string;
      source_local_user?: string;
      store_base_path_info: boolean;
      sync_level?: 0
      | 2
      | 1
      | 3;
      verify_checksum: boolean;
  }

  TransferTaskDocument

  • DATA: {
        checksum_algorithm?: string;
        DATA_TYPE: "transfer_item";
        destination_path: string;
        external_checksum?: string;
        recursive?: boolean;
        source_path: string;
    }[]

    Data

  • DATA_TYPE: "transfer"

    Data Type

    Default

    transfer
    @enum {string}
    Copy

  • Optionaldeadline?: string

    Deadline

  • delete_destination_extra: boolean

    Delete Destination Extra

    Default

    false
    Copy

  • destination_endpoint: string

    Destination Endpoint

  • Optionaldestination_local_user?: string

    Destination Local User

  • encrypt_data: boolean

    Encrypt Data

    Default

    false
    Copy

  • fail_on_quota_errors: boolean

    Fail On Quota Errors

    Default

    false
    Copy

  • Optionalfilter_rules?: {
        DATA_TYPE: "filter_rule";
        method: "include" | "exclude";
        name: string;
        type?: "file" | "dir";
    }[]

    Filter Rules

  • Optionallabel?: string

    Label

  • notify_on_failed: boolean

    Notify On Failed

    Default

    true
    Copy

  • notify_on_inactive: boolean

    Notify On Inactive

    Default

    true
    Copy

  • notify_on_succeeded: boolean

    Notify On Succeeded

    Default

    true
    Copy

  • preserve_timestamp: boolean

    Preserve Timestamp

    Default

    false
    Copy

  • skip_source_errors: boolean

    Skip Source Errors

    Default

    false
    Copy

  • source_endpoint: string

    Source Endpoint

  • Optionalsource_local_user?: string

    Source Local User

  • store_base_path_info: boolean

    Store Base Path Info

    Default

    false
    Copy

  • Optionalsync_level?: 0 | 2 | 1 | 3

    Sync Level

  • verify_checksum: boolean

    Verify Checksum

    Default

    false
    Copy

• TransferTaskItem: {
      checksum_algorithm?: string;
      DATA_TYPE: "transfer_item";
      destination_path: string;
      external_checksum?: string;
      recursive?: boolean;
      source_path: string;
  }

  TransferTaskItem

  • Optionalchecksum_algorithm?: string

    Checksum Algorithm

  • DATA_TYPE: "transfer_item"

    Data Type

    Default

    transfer_item
    @enum {string}
    Copy

  • destination_path: string

    Destination Path

  • Optionalexternal_checksum?: string

    External Checksum

  • Optionalrecursive?: boolean

    Recursive

  • source_path: string

    Source Path

• V2FlowTimerCreate: {
      body: {
          body: Record<string, unknown>;
          run_managers?: string[];
          run_monitors?: string[];
          tags?: string[];
      };
      flow_id: string;
      name?: string;
      schedule: | { datetime?: string; type: "once" }
      | {
          end?:
              | { condition: "iterations"; count: number }
              | { condition: "time"; datetime: string };
          interval_seconds: number;
          start?: string;
          type: "recurring";
      };
      timer_type: "flow";
  }

  V2FlowTimerCreate

  • body: {
        body: Record<string, unknown>;
        run_managers?: string[];
        run_monitors?: string[];
        tags?: string[];
    }

    • body: Record<string, unknown>

      Body

      Description

      Input variables to pass to the flow each time it is started.

    • Optionalrun_managers?: string[]

      Run Managers

      Description

      Principals (identities or groups) which are allowed to manage each run.

    • Optionalrun_monitors?: string[]

      Run Monitors

      Description

      Principals (identities or groups) which are allowed to monitor each run.

    • Optionaltags?: string[]

      Tags

      Description

      Tags that will be added to each run.

  • flow_id: string

    Flow Id Format: uuid

  • Optionalname?: string

    Name

  • schedule:
        | { datetime?: string; type: "once" }
        | {
            end?:
                | { condition: "iterations"; count: number }
                | { condition: "time"; datetime: string };
            interval_seconds: number;
            start?: string;
            type: "recurring";
        }

    Schedule

  • timer_type: "flow"

    Description

    discriminator enum property added by openapi-typescript

• V2FlowTimerRead: {
      activity?:
          | { code: "awaiting_next_run"; next_run: string }
          | {
              code: "run_in_progress";
              duration_seconds: number;
              start_timestamp: string;
          }
          | {
              code: "paused";
              reason: "other"
              | "user"
              | "globus_auth_requirements";
          }
          | { code: "retrying"; start_timestamp: string };
      body: {
          body: Record<string, unknown>;
          run_managers?: string[];
          run_monitors?: string[];
          tags?: string[];
      };
      flow_id: string;
      inactive_reason?: {
          cause: "user"
          | "globus_auth_requirements";
          detail?: Record<string, unknown>;
      };
      job_id: string;
      last_ran_at?: string;
      name?: string;
      next_run?: string;
      number_of_errors: number;
      number_of_runs: number;
      schedule: | { datetime?: string; type: "once" }
      | {
          end?:
              | { condition: "iterations"; count: number }
              | { condition: "time"; datetime: string };
          interval_seconds: number;
          start?: string;
          type: "recurring";
      };
      status: string;
      submitted_at: string;
      timer_type: "flow";
  }

  V2FlowTimerRead

  • Optionalactivity?:
        | { code: "awaiting_next_run"; next_run: string }
        | {
            code: "run_in_progress";
            duration_seconds: number;
            start_timestamp: string;
        }
        | { code: "paused"; reason: "other"
        | "user"
        | "globus_auth_requirements" }
        | { code: "retrying"; start_timestamp: string }

    Activity

  • body: {
        body: Record<string, unknown>;
        run_managers?: string[];
        run_monitors?: string[];
        tags?: string[];
    }

    • body: Record<string, unknown>

      Body

      Description

      Input variables to pass to the flow each time it is started.

    • Optionalrun_managers?: string[]

      Run Managers

      Description

      Principals (identities or groups) which are allowed to manage each run.

    • Optionalrun_monitors?: string[]

      Run Monitors

      Description

      Principals (identities or groups) which are allowed to monitor each run.

    • Optionaltags?: string[]

      Tags

      Description

      Tags that will be added to each run.

  • flow_id: string

    Flow Id Format: uuid

  • Optionalinactive_reason?: { cause: "user" | "globus_auth_requirements"; detail?: Record<string, unknown> }

    • cause: "user" | "globus_auth_requirements"

      Cause

    • Optionaldetail?: Record<string, unknown>

      Detail

  • job_id: string

    Job Id Format: uuid

  • Optionallast_ran_at?: string

    Last Ran At Format: date-time

  • Optionalname?: string

    Name

  • Optionalnext_run?: string

    Next Run Format: date-time

  • number_of_errors: number

    Number Of Errors

  • number_of_runs: number

    Number Of Runs

  • schedule:
        | { datetime?: string; type: "once" }
        | {
            end?:
                | { condition: "iterations"; count: number }
                | { condition: "time"; datetime: string };
            interval_seconds: number;
            start?: string;
            type: "recurring";
        }

    Schedule

  • status: string

    Status

  • submitted_at: string

    Submitted At Format: date-time

  • timer_type: "flow"

    Description

    discriminator enum property added by openapi-typescript

• V2TimerCreate: {
      timer:
          | {
              body: {
                  body: Record<string, unknown>;
                  run_managers?: string[];
                  run_monitors?: string[];
                  tags?: string[];
              };
              flow_id: string;
              name?: string;
              schedule: | { datetime?: string; type: "once" }
              | {
                  end?:
                      | { condition: "iterations"; count: number }
                      | { condition: "time"; datetime: string };
                  interval_seconds: number;
                  start?: string;
                  type: "recurring";
              };
              timer_type: "flow";
          }
          | {
              body: {
                  DATA: {
                      checksum_algorithm?: string;
                      DATA_TYPE: "transfer_item";
                      destination_path: string;
                      external_checksum?: string;
                      recursive?: boolean;
                      source_path: string;
                  }[];
                  DATA_TYPE: "transfer";
                  deadline?: string;
                  delete_destination_extra: boolean;
                  destination_endpoint: string;
                  destination_local_user?: string;
                  encrypt_data: boolean;
                  fail_on_quota_errors: boolean;
                  filter_rules?: {
                      DATA_TYPE: "filter_rule";
                      method: "include"
                      | "exclude";
                      name: string;
                      type?: "file" | "dir";
                  }[];
                  label?: string;
                  notify_on_failed: boolean;
                  notify_on_inactive: boolean;
                  notify_on_succeeded: boolean;
                  preserve_timestamp: boolean;
                  skip_source_errors: boolean;
                  source_endpoint: string;
                  source_local_user?: string;
                  store_base_path_info: boolean;
                  sync_level?: 0
                  | 2
                  | 1
                  | 3;
                  verify_checksum: boolean;
              };
              name?: string;
              resource_server: "transfer.api.globus.org";
              schedule: | { datetime?: string; type: "once" }
              | {
                  end?:
                      | { condition: "iterations"; count: number }
                      | { condition: "time"; datetime: string };
                  interval_seconds: number;
                  start?: string;
                  type: "recurring";
              };
              timer_type: "transfer";
          };
  }

  V2TimerCreate

  • timer:
        | {
            body: {
                body: Record<string, unknown>;
                run_managers?: string[];
                run_monitors?: string[];
                tags?: string[];
            };
            flow_id: string;
            name?: string;
            schedule: | { datetime?: string; type: "once" }
            | {
                end?:
                    | { condition: "iterations"; count: number }
                    | { condition: "time"; datetime: string };
                interval_seconds: number;
                start?: string;
                type: "recurring";
            };
            timer_type: "flow";
        }
        | {
            body: {
                DATA: {
                    checksum_algorithm?: string;
                    DATA_TYPE: "transfer_item";
                    destination_path: string;
                    external_checksum?: string;
                    recursive?: boolean;
                    source_path: string;
                }[];
                DATA_TYPE: "transfer";
                deadline?: string;
                delete_destination_extra: boolean;
                destination_endpoint: string;
                destination_local_user?: string;
                encrypt_data: boolean;
                fail_on_quota_errors: boolean;
                filter_rules?: {
                    DATA_TYPE: "filter_rule";
                    method: "include"
                    | "exclude";
                    name: string;
                    type?: "file" | "dir";
                }[];
                label?: string;
                notify_on_failed: boolean;
                notify_on_inactive: boolean;
                notify_on_succeeded: boolean;
                preserve_timestamp: boolean;
                skip_source_errors: boolean;
                source_endpoint: string;
                source_local_user?: string;
                store_base_path_info: boolean;
                sync_level?: 0
                | 2
                | 1
                | 3;
                verify_checksum: boolean;
            };
            name?: string;
            resource_server: "transfer.api.globus.org";
            schedule: | { datetime?: string; type: "once" }
            | {
                end?:
                    | { condition: "iterations"; count: number }
                    | { condition: "time"; datetime: string };
                interval_seconds: number;
                start?: string;
                type: "recurring";
            };
            timer_type: "transfer";
        }

    Timer

• V2TimerRead: {
      timer:
          | {
              activity?: | { code: "awaiting_next_run"; next_run: string }
              | {
                  code: "run_in_progress";
                  duration_seconds: number;
                  start_timestamp: string;
              }
              | {
                  code: "paused";
                  reason: "other"
                  | "user"
                  | "globus_auth_requirements";
              }
              | { code: "retrying"; start_timestamp: string };
              body: {
                  body: Record<string, unknown>;
                  run_managers?: string[];
                  run_monitors?: string[];
                  tags?: string[];
              };
              flow_id: string;
              inactive_reason?: {
                  cause: "user"
                  | "globus_auth_requirements";
                  detail?: Record<string, unknown>;
              };
              job_id: string;
              last_ran_at?: string;
              name?: string;
              next_run?: string;
              number_of_errors: number;
              number_of_runs: number;
              schedule: | { datetime?: string; type: "once" }
              | {
                  end?:
                      | { condition: "iterations"; count: number }
                      | { condition: "time"; datetime: string };
                  interval_seconds: number;
                  start?: string;
                  type: "recurring";
              };
              status: string;
              submitted_at: string;
              timer_type: "flow";
          }
          | {
              activity?: | { code: "awaiting_next_run"; next_run: string }
              | {
                  code: "run_in_progress";
                  duration_seconds: number;
                  start_timestamp: string;
              }
              | {
                  code: "paused";
                  reason: "other"
                  | "user"
                  | "globus_auth_requirements";
              }
              | { code: "retrying"; start_timestamp: string };
              body: {
                  DATA: {
                      checksum_algorithm?: string;
                      DATA_TYPE: "transfer_item";
                      destination_path: string;
                      external_checksum?: string;
                      recursive?: boolean;
                      source_path: string;
                  }[];
                  DATA_TYPE: "transfer";
                  deadline?: string;
                  delete_destination_extra: boolean;
                  destination_endpoint: string;
                  destination_local_user?: string;
                  encrypt_data: boolean;
                  fail_on_quota_errors: boolean;
                  filter_rules?: {
                      DATA_TYPE: "filter_rule";
                      method: "include"
                      | "exclude";
                      name: string;
                      type?: "file" | "dir";
                  }[];
                  label?: string;
                  notify_on_failed: boolean;
                  notify_on_inactive: boolean;
                  notify_on_succeeded: boolean;
                  preserve_timestamp: boolean;
                  skip_source_errors: boolean;
                  source_endpoint: string;
                  source_local_user?: string;
                  store_base_path_info: boolean;
                  sync_level?: 0
                  | 2
                  | 1
                  | 3;
                  verify_checksum: boolean;
              };
              inactive_reason?: {
                  cause: "user"
                  | "globus_auth_requirements";
                  detail?: Record<string, unknown>;
              };
              job_id: string;
              last_ran_at?: string;
              name?: string;
              next_run?: string;
              number_of_errors: number;
              number_of_runs: number;
              schedule: | { datetime?: string; type: "once" }
              | {
                  end?:
                      | { condition: "iterations"; count: number }
                      | { condition: "time"; datetime: string };
                  interval_seconds: number;
                  start?: string;
                  type: "recurring";
              };
              status: string;
              submitted_at: string;
              timer_type: "transfer";
          };
  }

  V2TimerRead

  • timer:
        | {
            activity?: | { code: "awaiting_next_run"; next_run: string }
            | {
                code: "run_in_progress";
                duration_seconds: number;
                start_timestamp: string;
            }
            | {
                code: "paused";
                reason: "other"
                | "user"
                | "globus_auth_requirements";
            }
            | { code: "retrying"; start_timestamp: string };
            body: {
                body: Record<string, unknown>;
                run_managers?: string[];
                run_monitors?: string[];
                tags?: string[];
            };
            flow_id: string;
            inactive_reason?: {
                cause: "user"
                | "globus_auth_requirements";
                detail?: Record<string, unknown>;
            };
            job_id: string;
            last_ran_at?: string;
            name?: string;
            next_run?: string;
            number_of_errors: number;
            number_of_runs: number;
            schedule: | { datetime?: string; type: "once" }
            | {
                end?:
                    | { condition: "iterations"; count: number }
                    | { condition: "time"; datetime: string };
                interval_seconds: number;
                start?: string;
                type: "recurring";
            };
            status: string;
            submitted_at: string;
            timer_type: "flow";
        }
        | {
            activity?: | { code: "awaiting_next_run"; next_run: string }
            | {
                code: "run_in_progress";
                duration_seconds: number;
                start_timestamp: string;
            }
            | {
                code: "paused";
                reason: "other"
                | "user"
                | "globus_auth_requirements";
            }
            | { code: "retrying"; start_timestamp: string };
            body: {
                DATA: {
                    checksum_algorithm?: string;
                    DATA_TYPE: "transfer_item";
                    destination_path: string;
                    external_checksum?: string;
                    recursive?: boolean;
                    source_path: string;
                }[];
                DATA_TYPE: "transfer";
                deadline?: string;
                delete_destination_extra: boolean;
                destination_endpoint: string;
                destination_local_user?: string;
                encrypt_data: boolean;
                fail_on_quota_errors: boolean;
                filter_rules?: {
                    DATA_TYPE: "filter_rule";
                    method: "include"
                    | "exclude";
                    name: string;
                    type?: "file" | "dir";
                }[];
                label?: string;
                notify_on_failed: boolean;
                notify_on_inactive: boolean;
                notify_on_succeeded: boolean;
                preserve_timestamp: boolean;
                skip_source_errors: boolean;
                source_endpoint: string;
                source_local_user?: string;
                store_base_path_info: boolean;
                sync_level?: 0
                | 2
                | 1
                | 3;
                verify_checksum: boolean;
            };
            inactive_reason?: {
                cause: "user"
                | "globus_auth_requirements";
                detail?: Record<string, unknown>;
            };
            job_id: string;
            last_ran_at?: string;
            name?: string;
            next_run?: string;
            number_of_errors: number;
            number_of_runs: number;
            schedule: | { datetime?: string; type: "once" }
            | {
                end?:
                    | { condition: "iterations"; count: number }
                    | { condition: "time"; datetime: string };
                interval_seconds: number;
                start?: string;
                type: "recurring";
            };
            status: string;
            submitted_at: string;
            timer_type: "transfer";
        }

    Timer

• V2TransferTimerCreate: {
      body: {
          DATA: {
              checksum_algorithm?: string;
              DATA_TYPE: "transfer_item";
              destination_path: string;
              external_checksum?: string;
              recursive?: boolean;
              source_path: string;
          }[];
          DATA_TYPE: "transfer";
          deadline?: string;
          delete_destination_extra: boolean;
          destination_endpoint: string;
          destination_local_user?: string;
          encrypt_data: boolean;
          fail_on_quota_errors: boolean;
          filter_rules?: {
              DATA_TYPE: "filter_rule";
              method: "include"
              | "exclude";
              name: string;
              type?: "file" | "dir";
          }[];
          label?: string;
          notify_on_failed: boolean;
          notify_on_inactive: boolean;
          notify_on_succeeded: boolean;
          preserve_timestamp: boolean;
          skip_source_errors: boolean;
          source_endpoint: string;
          source_local_user?: string;
          store_base_path_info: boolean;
          sync_level?: 0
          | 2
          | 1
          | 3;
          verify_checksum: boolean;
      };
      name?: string;
      resource_server: "transfer.api.globus.org";
      schedule: | { datetime?: string; type: "once" }
      | {
          end?:
              | { condition: "iterations"; count: number }
              | { condition: "time"; datetime: string };
          interval_seconds: number;
          start?: string;
          type: "recurring";
      };
      timer_type: "transfer";
  }

  V2TransferTimerCreate

  • body: {
        DATA: {
            checksum_algorithm?: string;
            DATA_TYPE: "transfer_item";
            destination_path: string;
            external_checksum?: string;
            recursive?: boolean;
            source_path: string;
        }[];
        DATA_TYPE: "transfer";
        deadline?: string;
        delete_destination_extra: boolean;
        destination_endpoint: string;
        destination_local_user?: string;
        encrypt_data: boolean;
        fail_on_quota_errors: boolean;
        filter_rules?: {
            DATA_TYPE: "filter_rule";
            method: "include"
            | "exclude";
            name: string;
            type?: "file" | "dir";
        }[];
        label?: string;
        notify_on_failed: boolean;
        notify_on_inactive: boolean;
        notify_on_succeeded: boolean;
        preserve_timestamp: boolean;
        skip_source_errors: boolean;
        source_endpoint: string;
        source_local_user?: string;
        store_base_path_info: boolean;
        sync_level?: 0
        | 2
        | 1
        | 3;
        verify_checksum: boolean;
    }

    • DATA: {
          checksum_algorithm?: string;
          DATA_TYPE: "transfer_item";
          destination_path: string;
          external_checksum?: string;
          recursive?: boolean;
          source_path: string;
      }[]

      Data

    • DATA_TYPE: "transfer"

      Data Type

      Default

      transfer
      @enum {string}
      Copy

    • Optionaldeadline?: string

      Deadline

    • delete_destination_extra: boolean

      Delete Destination Extra

      Default

      false
      Copy

    • destination_endpoint: string

      Destination Endpoint

    • Optionaldestination_local_user?: string

      Destination Local User

    • encrypt_data: boolean

      Encrypt Data

      Default

      false
      Copy

    • fail_on_quota_errors: boolean

      Fail On Quota Errors

      Default

      false
      Copy

    • Optionalfilter_rules?: {
          DATA_TYPE: "filter_rule";
          method: "include" | "exclude";
          name: string;
          type?: "file" | "dir";
      }[]

      Filter Rules

    • Optionallabel?: string

      Label

    • notify_on_failed: boolean

      Notify On Failed

      Default

      true
      Copy

    • notify_on_inactive: boolean

      Notify On Inactive

      Default

      true
      Copy

    • notify_on_succeeded: boolean

      Notify On Succeeded

      Default

      true
      Copy

    • preserve_timestamp: boolean

      Preserve Timestamp

      Default

      false
      Copy

    • skip_source_errors: boolean

      Skip Source Errors

      Default

      false
      Copy

    • source_endpoint: string

      Source Endpoint

    • Optionalsource_local_user?: string

      Source Local User

    • store_base_path_info: boolean

      Store Base Path Info

      Default

      false
      Copy

    • Optionalsync_level?: 0 | 2 | 1 | 3

      Sync Level

    • verify_checksum: boolean

      Verify Checksum

      Default

      false
      Copy

  • Optionalname?: string

    Name

  • resource_server: "transfer.api.globus.org"

    Resource Server

    Default

    transfer.api.globus.org
    @enum {string}
    Copy

  • schedule:
        | { datetime?: string; type: "once" }
        | {
            end?:
                | { condition: "iterations"; count: number }
                | { condition: "time"; datetime: string };
            interval_seconds: number;
            start?: string;
            type: "recurring";
        }

    Schedule

  • timer_type: "transfer"

    Description

    discriminator enum property added by openapi-typescript

• V2TransferTimerRead: {
      activity?:
          | { code: "awaiting_next_run"; next_run: string }
          | {
              code: "run_in_progress";
              duration_seconds: number;
              start_timestamp: string;
          }
          | {
              code: "paused";
              reason: "other"
              | "user"
              | "globus_auth_requirements";
          }
          | { code: "retrying"; start_timestamp: string };
      body: {
          DATA: {
              checksum_algorithm?: string;
              DATA_TYPE: "transfer_item";
              destination_path: string;
              external_checksum?: string;
              recursive?: boolean;
              source_path: string;
          }[];
          DATA_TYPE: "transfer";
          deadline?: string;
          delete_destination_extra: boolean;
          destination_endpoint: string;
          destination_local_user?: string;
          encrypt_data: boolean;
          fail_on_quota_errors: boolean;
          filter_rules?: {
              DATA_TYPE: "filter_rule";
              method: "include"
              | "exclude";
              name: string;
              type?: "file" | "dir";
          }[];
          label?: string;
          notify_on_failed: boolean;
          notify_on_inactive: boolean;
          notify_on_succeeded: boolean;
          preserve_timestamp: boolean;
          skip_source_errors: boolean;
          source_endpoint: string;
          source_local_user?: string;
          store_base_path_info: boolean;
          sync_level?: 0
          | 2
          | 1
          | 3;
          verify_checksum: boolean;
      };
      inactive_reason?: {
          cause: "user"
          | "globus_auth_requirements";
          detail?: Record<string, unknown>;
      };
      job_id: string;
      last_ran_at?: string;
      name?: string;
      next_run?: string;
      number_of_errors: number;
      number_of_runs: number;
      schedule: | { datetime?: string; type: "once" }
      | {
          end?:
              | { condition: "iterations"; count: number }
              | { condition: "time"; datetime: string };
          interval_seconds: number;
          start?: string;
          type: "recurring";
      };
      status: string;
      submitted_at: string;
      timer_type: "transfer";
  }

  V2TransferTimerRead

  • Optionalactivity?:
        | { code: "awaiting_next_run"; next_run: string }
        | {
            code: "run_in_progress";
            duration_seconds: number;
            start_timestamp: string;
        }
        | { code: "paused"; reason: "other"
        | "user"
        | "globus_auth_requirements" }
        | { code: "retrying"; start_timestamp: string }

    Activity

  • body: {
        DATA: {
            checksum_algorithm?: string;
            DATA_TYPE: "transfer_item";
            destination_path: string;
            external_checksum?: string;
            recursive?: boolean;
            source_path: string;
        }[];
        DATA_TYPE: "transfer";
        deadline?: string;
        delete_destination_extra: boolean;
        destination_endpoint: string;
        destination_local_user?: string;
        encrypt_data: boolean;
        fail_on_quota_errors: boolean;
        filter_rules?: {
            DATA_TYPE: "filter_rule";
            method: "include"
            | "exclude";
            name: string;
            type?: "file" | "dir";
        }[];
        label?: string;
        notify_on_failed: boolean;
        notify_on_inactive: boolean;
        notify_on_succeeded: boolean;
        preserve_timestamp: boolean;
        skip_source_errors: boolean;
        source_endpoint: string;
        source_local_user?: string;
        store_base_path_info: boolean;
        sync_level?: 0
        | 2
        | 1
        | 3;
        verify_checksum: boolean;
    }

    • DATA: {
          checksum_algorithm?: string;
          DATA_TYPE: "transfer_item";
          destination_path: string;
          external_checksum?: string;
          recursive?: boolean;
          source_path: string;
      }[]

      Data

    • DATA_TYPE: "transfer"

      Data Type

      Default

      transfer
      @enum {string}
      Copy

    • Optionaldeadline?: string

      Deadline

    • delete_destination_extra: boolean

      Delete Destination Extra

      Default

      false
      Copy

    • destination_endpoint: string

      Destination Endpoint

    • Optionaldestination_local_user?: string

      Destination Local User

    • encrypt_data: boolean

      Encrypt Data

      Default

      false
      Copy

    • fail_on_quota_errors: boolean

      Fail On Quota Errors

      Default

      false
      Copy

    • Optionalfilter_rules?: {
          DATA_TYPE: "filter_rule";
          method: "include" | "exclude";
          name: string;
          type?: "file" | "dir";
      }[]

      Filter Rules

    • Optionallabel?: string

      Label

    • notify_on_failed: boolean

      Notify On Failed

      Default

      true
      Copy

    • notify_on_inactive: boolean

      Notify On Inactive

      Default

      true
      Copy

    • notify_on_succeeded: boolean

      Notify On Succeeded

      Default

      true
      Copy

    • preserve_timestamp: boolean

      Preserve Timestamp

      Default

      false
      Copy

    • skip_source_errors: boolean

      Skip Source Errors

      Default

      false
      Copy

    • source_endpoint: string

      Source Endpoint

    • Optionalsource_local_user?: string

      Source Local User

    • store_base_path_info: boolean

      Store Base Path Info

      Default

      false
      Copy

    • Optionalsync_level?: 0 | 2 | 1 | 3

      Sync Level

    • verify_checksum: boolean

      Verify Checksum

      Default

      false
      Copy

  • Optionalinactive_reason?: { cause: "user" | "globus_auth_requirements"; detail?: Record<string, unknown> }

    • cause: "user" | "globus_auth_requirements"

      Cause

    • Optionaldetail?: Record<string, unknown>

      Detail

  • job_id: string

    Job Id Format: uuid

  • Optionallast_ran_at?: string

    Last Ran At Format: date-time

  • Optionalname?: string

    Name

  • Optionalnext_run?: string

    Next Run Format: date-time

  • number_of_errors: number

    Number Of Errors

  • number_of_runs: number

    Number Of Runs

  • schedule:
        | { datetime?: string; type: "once" }
        | {
            end?:
                | { condition: "iterations"; count: number }
                | { condition: "time"; datetime: string };
            interval_seconds: number;
            start?: string;
            type: "recurring";
        }

    Schedule

  • status: string

    Status

  • submitted_at: string

    Submitted At Format: date-time

  • timer_type: "transfer"

    Description

    discriminator enum property added by openapi-typescript

• ValidationError: { loc: (string | number)[]; msg: string; type: string }

  ValidationError

  • loc: (string | number)[]

    Location

  • msg: string

    Message

  • type: string

    Error Type