Function getTasks

Parameters

• params: IaGetSessionParams & {
      args?: string;
      catalog?: 0 | 1;
      cmd?: string;
      cursor?: string;
      history?: 0 | 1;
      identifier?: string;
      limit?: number;
      priority?: number;
      server?: string;
      submitter?: string;
      "submittime<"?: string;
      "submittime<="?: string;
      "submittime>"?: string;
      "submittime>="?: string;
      summary?: 0 | 1;
      task_id?: number;
      wait_admin?: number;
  }

  The URL parameters to send with each request sent to the Archive.org catalog API.

  • Optionalargs?: string

    Argument list (see below; may be wildcarded)

  • Optionalcatalog?: 0 | 1

    A list of all active tasks (queued, running, error, or paused) matching the supplied criteria

  • Optionalcmd?: string

    Task command (e.g., archive.php, modify_xml.php, etc.; may be wildcarded)

  • Optionalcursor?: string

    Cursor for pagination

  • Optionalhistory?: 0 | 1

    A list of all completed tasks matching the supplied criteria

  • Optionalidentifier?: string

    The item identifier, if provided will return tasks for only this item filtered by other criteria provided in params.

  • Optionallimit?: number

    The current default is 50 tasks per request, but the caller may request more with the limit parameter The current maximum limit is 500 tasks. Values outside this range are clamped to the server maximum. If the caller wishes to receive all tasks in a single round-trip, they may set limit=0 in the request query.

    Default

    50
    Copy

  • Optionalpriority?: number

    Generally from 10 to -10

  • Optionalserver?: string

    IA node task will or was executed upon (may be wildcarded)

  • Optionalsubmitter?: string

    User submitting task (may be wildcarded)

  • Optionalsubmittime<?: string

    Filter by submit time lower than supplied time. Time must be formatted as "YYYY-MM-DD"

  • Optionalsubmittime<=?: string

    Filter by submit time lower or equal to supplied time. Time must be formatted as "YYYY-MM-DD"

  • Optionalsubmittime>?: string

    Filter by submit time greater than supplied time. Time must be formatted as "YYYY-MM-DD"

  • Optionalsubmittime>=?: string

    Filter by submit time greater or equal to supplied time. Time must be formatted as "YYYY-MM-DD"

  • Optionalsummary?: 0 | 1

    Total counts of catalog tasks meeting all criteria organized by run status (queued, running, error, and paused). Historical totals are currently unavailable.

    Default

    1
    Copy

  • Optionaltask_id?: number

    Task identifier

  • Optionalwait_admin?: number

    Task run state (see below)