Interface components

interface components {
    headers: never;
    parameters: never;
    pathItems: never;
    requestBodies: never;
    responses: never;
    schemas: {
        EndConditionIterations: { condition: "iterations"; count: number };
        EndConditionTime: { condition: "time"; datetime: string };
        FilterRule: {
            DATA_TYPE: "filter_rule";
            method: "include" | "exclude";
            name: string;
            type?: "file" | "dir";
        };
        HTTPValidationError: {
            detail?: { loc: (string | number)[]; msg: string; type: string }[];
        };
        JobCreate: {
            callback_body: Record<string, unknown>;
            callback_url: string;
            interval?: number;
            name?: string;
            refresh_token?: string;
            scope?: string;
            start: string;
            stop_after?: { date?: string; n_runs?: number };
        };
        JobInactiveReason: {
            cause: "user"
            | "globus_auth_requirements";
            detail?: Record<string, unknown>;
        };
        JobRead: {
            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;
        };
        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;
        };
        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;
        };
        JobResumeBehavior: {
            action: "run_once_immediately"
            | "wait_for_next_scheduled";
        };
        JobUpdate: { name?: string };
        MessageResponse: { message: string };
        OnceSchedule: { datetime?: string; type: "once" };
        RecurringSchedule: {
            end?:
                | { condition: "iterations"; count: number }
                | { condition: "time"; datetime: string };
            interval_seconds: number;
            start?: string;
            type: "recurring";
        };
        StopAfter: { date?: string; n_runs?: number };
        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;
        };
        TransferTaskItem: {
            checksum_algorithm?: string;
            DATA_TYPE: "transfer_item";
            destination_path: string;
            external_checksum?: string;
            recursive?: boolean;
            source_path: string;
        };
        V2TimerCreate: {
            timer: {
                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";
            };
        };
        V2TimerRead: {
            timer: {
                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";
            };
        };
        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";
        };
        V2TransferTimerRead: {
            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";
        };
        ValidationError: { loc: (string | number)[]; msg: string; type: string };
    };
}

Index

Properties

headers parameters pathItems requestBodies responses schemas

Properties

headers

headers: never

parameters

parameters: never

pathItems

pathItems: never

requestBodies

requestBodies: never

responses

responses: never

schemas

schemas: {
    EndConditionIterations: { condition: "iterations"; count: number };
    EndConditionTime: { condition: "time"; datetime: string };
    FilterRule: {
        DATA_TYPE: "filter_rule";
        method: "include" | "exclude";
        name: string;
        type?: "file" | "dir";
    };
    HTTPValidationError: {
        detail?: { loc: (string | number)[]; msg: string; type: string }[];
    };
    JobCreate: {
        callback_body: Record<string, unknown>;
        callback_url: string;
        interval?: number;
        name?: string;
        refresh_token?: string;
        scope?: string;
        start: string;
        stop_after?: { date?: string; n_runs?: number };
    };
    JobInactiveReason: {
        cause: "user"
        | "globus_auth_requirements";
        detail?: Record<string, unknown>;
    };
    JobRead: {
        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;
    };
    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;
    };
    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;
    };
    JobResumeBehavior: {
        action: "run_once_immediately"
        | "wait_for_next_scheduled";
    };
    JobUpdate: { name?: string };
    MessageResponse: { message: string };
    OnceSchedule: { datetime?: string; type: "once" };
    RecurringSchedule: {
        end?:
            | { condition: "iterations"; count: number }
            | { condition: "time"; datetime: string };
        interval_seconds: number;
        start?: string;
        type: "recurring";
    };
    StopAfter: { date?: string; n_runs?: number };
    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;
    };
    TransferTaskItem: {
        checksum_algorithm?: string;
        DATA_TYPE: "transfer_item";
        destination_path: string;
        external_checksum?: string;
        recursive?: boolean;
        source_path: string;
    };
    V2TimerCreate: {
        timer: {
            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";
        };
    };
    V2TimerRead: {
        timer: {
            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";
        };
    };
    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";
    };
    V2TransferTimerRead: {
        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";
    };
    ValidationError: { loc: (string | number)[]; msg: string; type: string };
}

Type declaration

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}
```
- 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}
```
- 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}
```
- method: "include" | "exclude"
  Method
  Default
```
exclude
@enum {string}
```
- name: string
  Name
- Optionaltype?: "file" | "dir"
  Type
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?: { date?: string; n_runs?: number };
}
JobCreate
- callback_body: Record<string, unknown>
  Callback Body
  Example
```
{
             *       "request_id": "a403b459-376e-47a2-a55d-30e7ddbcc3d2",
             *       "body": {
             *         "source_endpoint_id": "just_an_example"
             *       }
             *     }
```
- callback_url: string
  Callback Url Format: uri
  Example
```
[
      "https://actions.automate.globus.org/transfer/transfer/run"
    ]
```
- 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
```
- start: string
  Start Format: date-time
- Optionalstop_after?: { date?: string; n_runs?: number }
  - Optionaldate?: string
    Date Format: date-time
  - Optionaln_runs?: number
    N Runs
JobInactiveReason: { cause: "user" | "globus_auth_requirements"; detail?: Record<string, unknown> }
JobInactiveReason
- cause: "user" | "globus_auth_requirements"
  Cause
- Optionaldetail?: Record<string, unknown>
  Detail
JobRead: {
    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;
}
JobRead
- callback_body: Record<string, unknown>
  Callback Body
  Example
```
{
             *       "request_id": "a403b459-376e-47a2-a55d-30e7ddbcc3d2",
             *       "body": {
             *         "source_endpoint_id": "just_an_example"
             *       }
             *     }
```
- callback_url: string
  Callback Url Format: uri
  Example
```
[
      "https://actions.automate.globus.org/transfer/transfer/run"
    ]
```
- 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
```
- start: string
  Start Format: date-time
- status: string
  Status
- Optionalstop_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
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
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}
```
- Optionaldeadline?: string
  Deadline
- delete_destination_extra: boolean
  Delete Destination Extra
  Default
```
false
```
- destination_endpoint: string
  Destination Endpoint
- Optionaldestination_local_user?: string
  Destination Local User
- encrypt_data: boolean
  Encrypt Data
  Default
```
false
```
- fail_on_quota_errors: boolean
  Fail On Quota Errors
  Default
```
false
```
- 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
```
- notify_on_inactive: boolean
  Notify On Inactive
  Default
```
true
```
- notify_on_succeeded: boolean
  Notify On Succeeded
  Default
```
true
```
- preserve_timestamp: boolean
  Preserve Timestamp
  Default
```
false
```
- skip_source_errors: boolean
  Skip Source Errors
  Default
```
false
```
- source_endpoint: string
  Source Endpoint
- Optionalsource_local_user?: string
  Source Local User
- store_base_path_info: boolean
  Store Base Path Info
  Default
```
false
```
- Optionalsync_level?: 0 | 2 | 1 | 3
  Sync Level
- verify_checksum: boolean
  Verify Checksum
  Default
```
false
```
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}
```
- destination_path: string
  Destination Path
- Optionalexternal_checksum?: string
  External Checksum
- Optionalrecursive?: boolean
  Recursive
- source_path: string
  Source Path
V2TimerCreate: {
    timer: {
        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: {
          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";
  }
  - 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}
    - Optionaldeadline?: string
      Deadline
    - delete_destination_extra: boolean
      Delete Destination Extra
      Default
      false
    - destination_endpoint: string
      Destination Endpoint
    - Optionaldestination_local_user?: string
      Destination Local User
    - encrypt_data: boolean
      Encrypt Data
      Default
      false
    - fail_on_quota_errors: boolean
      Fail On Quota Errors
      Default
      false
    - 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
    - notify_on_inactive: boolean
      Notify On Inactive
      Default
      true
    - notify_on_succeeded: boolean
      Notify On Succeeded
      Default
      true
    - preserve_timestamp: boolean
      Preserve Timestamp
      Default
      false
    - skip_source_errors: boolean
      Skip Source Errors
      Default
      false
    - source_endpoint: string
      Source Endpoint
    - Optionalsource_local_user?: string
      Source Local User
    - store_base_path_info: boolean
      Store Base Path Info
      Default
      false
    - Optionalsync_level?: 0 | 2 | 1 | 3
      Sync Level
    - verify_checksum: boolean
      Verify Checksum
      Default
      false
  - Optionalname?: string
    Name
  - resource_server: "transfer.api.globus.org"
    Resource Server
    Default
    transfer.api.globus.org @enum {string}
  - 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"
    Timer Type
V2TimerRead: {
    timer: {
        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: {
      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";
  }
  - 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}
    - Optionaldeadline?: string
      Deadline
    - delete_destination_extra: boolean
      Delete Destination Extra
      Default
      false
    - destination_endpoint: string
      Destination Endpoint
    - Optionaldestination_local_user?: string
      Destination Local User
    - encrypt_data: boolean
      Encrypt Data
      Default
      false
    - fail_on_quota_errors: boolean
      Fail On Quota Errors
      Default
      false
    - 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
    - notify_on_inactive: boolean
      Notify On Inactive
      Default
      true
    - notify_on_succeeded: boolean
      Notify On Succeeded
      Default
      true
    - preserve_timestamp: boolean
      Preserve Timestamp
      Default
      false
    - skip_source_errors: boolean
      Skip Source Errors
      Default
      false
    - source_endpoint: string
      Source Endpoint
    - Optionalsource_local_user?: string
      Source Local User
    - store_base_path_info: boolean
      Store Base Path Info
      Default
      false
    - Optionalsync_level?: 0 | 2 | 1 | 3
      Sync Level
    - verify_checksum: boolean
      Verify Checksum
      Default
      false
  - 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"
    Timer Type
    Default
    transfer @enum {string}
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}
  - Optionaldeadline?: string
    Deadline
  - delete_destination_extra: boolean
    Delete Destination Extra
    Default
    false
  - destination_endpoint: string
    Destination Endpoint
  - Optionaldestination_local_user?: string
    Destination Local User
  - encrypt_data: boolean
    Encrypt Data
    Default
    false
  - fail_on_quota_errors: boolean
    Fail On Quota Errors
    Default
    false
  - 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
  - notify_on_inactive: boolean
    Notify On Inactive
    Default
    true
  - notify_on_succeeded: boolean
    Notify On Succeeded
    Default
    true
  - preserve_timestamp: boolean
    Preserve Timestamp
    Default
    false
  - skip_source_errors: boolean
    Skip Source Errors
    Default
    false
  - source_endpoint: string
    Source Endpoint
  - Optionalsource_local_user?: string
    Source Local User
  - store_base_path_info: boolean
    Store Base Path Info
    Default
    false
  - Optionalsync_level?: 0 | 2 | 1 | 3
    Sync Level
  - verify_checksum: boolean
    Verify Checksum
    Default
    false
- Optionalname?: string
  Name
- resource_server: "transfer.api.globus.org"
  Resource Server
  Default
```
transfer.api.globus.org
@enum {string}
```
- 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"
  Timer Type
V2TransferTimerRead: {
    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
- 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}
  - Optionaldeadline?: string
    Deadline
  - delete_destination_extra: boolean
    Delete Destination Extra
    Default
    false
  - destination_endpoint: string
    Destination Endpoint
  - Optionaldestination_local_user?: string
    Destination Local User
  - encrypt_data: boolean
    Encrypt Data
    Default
    false
  - fail_on_quota_errors: boolean
    Fail On Quota Errors
    Default
    false
  - 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
  - notify_on_inactive: boolean
    Notify On Inactive
    Default
    true
  - notify_on_succeeded: boolean
    Notify On Succeeded
    Default
    true
  - preserve_timestamp: boolean
    Preserve Timestamp
    Default
    false
  - skip_source_errors: boolean
    Skip Source Errors
    Default
    false
  - source_endpoint: string
    Source Endpoint
  - Optionalsource_local_user?: string
    Source Local User
  - store_base_path_info: boolean
    Store Base Path Info
    Default
    false
  - Optionalsync_level?: 0 | 2 | 1 | 3
    Sync Level
  - verify_checksum: boolean
    Verify Checksum
    Default
    false
- 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"
  Timer Type
  Default
```
transfer
@enum {string}
```
ValidationError: { loc: (string | number)[]; msg: string; type: string }
ValidationError
- loc: (string | number)[]
  Location
- msg: string
  Message
- type: string
  Error Type

Interface components

Index

Properties

Properties

headers

parameters

pathItems

requestBodies

responses

schemas

Type declaration

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

Description

condition: "iterations"

Default

count: number

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

Description

condition: "time"

Default

datetime: string

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

DATA_TYPE: "filter_rule"

Default

method: "include" | "exclude"

Default

name: string

Optionaltype?: "file" | "dir"

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

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

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

callback_body: Record<string, unknown>

Example

callback_url: string

Example

Optionalinterval?: number

Optionalname?: string

Optionalrefresh_token?: string

Optionalscope?: string

Example

start: string

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

Optionaldate?: string

Optionaln_runs?: number

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

cause: "user" | "globus_auth_requirements"

Optionaldetail?: Record<string, unknown>

callback_body: Record<string, unknown>

Example

callback_url: string

Example

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

cause: "user" | "globus_auth_requirements"

Optionaldetail?: Record<string, unknown>

Optionalinterval?: number

job_id: string

Optionallast_ran_at?: string

n_errors: number

n_runs: number

Optionalname?: string

Optionalnext_run?: string

Optionalpage_next?: string

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

Optionalscope?: string

Example

start: string

status: string

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

Optionaldate?: string

Optionaln_runs?: number

submitted_at: string

Optionaldata?: Record<string, unknown>

Optionalend_timestamp?: string

Optionalerrors?: Record<string, unknown>

Optionalhttp_status_polled?: number

Optionalhttp_status_submission?: number

Optionallast_check_timestamp?: string

Optionalnext_check_timestamp?: string

ran_at: string

Optionalresource_id?: string

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

`Optional`type?: "file" | "dir"

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

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

`Optional`interval?: number

`Optional`name?: string

`Optional`refresh_token?: string

`Optional`scope?: string

`Optional`stop_after?: { date?: string; n_runs?: number }

`Optional`date?: string

`Optional`n_runs?: number

`Optional`detail?: Record<string, unknown>

`Optional`inactive_reason?: { cause: "user" | "globus_auth_requirements"; detail?: Record<string, unknown> }

`Optional`detail?: Record<string, unknown>

`Optional`interval?: number

`Optional`last_ran_at?: string

`Optional`name?: string

`Optional`next_run?: string

`Optional`page_next?: string

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

`Optional`scope?: string

`Optional`stop_after?: { date?: string; n_runs?: number }

`Optional`date?: string

`Optional`n_runs?: number

`Optional`data?: Record<string, unknown>

`Optional`end_timestamp?: string

`Optional`errors?: Record<string, unknown>

`Optional`http_status_polled?: number

`Optional`http_status_submission?: number

`Optional`last_check_timestamp?: string

`Optional`next_check_timestamp?: string

`Optional`resource_id?: string

`Optional`status?: number

`Optional`page_next?: string

`Optional`name?: string

`Optional`datetime?: string

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

`Optional`end?:
| { condition: "iterations"; count: number }
| { condition: "time"; datetime: string }

`Optional`start?: string

`Optional`date?: string

`Optional`n_runs?: number

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

`Optional`deadline?: string

`Optional`destination_local_user?: string

`Optional`filter_rules?: {
DATA_TYPE: "filter_rule";
method: "include" | "exclude";
name: string;
type?: "file" | "dir";
}[]

`Optional`label?: string

`Optional`source_local_user?: string

`Optional`sync_level?: 0 | 2 | 1 | 3

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

`Optional`checksum_algorithm?: string