Skip to content
Sursa Developers

Objects

Job

Fields

  • expandedJobExpanded
  • attemptsintegerrequired
  • batch_idstring | null
  • cancelablebooleanrequired
  • card_idstring | nullrequired
  • collectionstring | nullrequired
  • created_atstring (date-time)required
  • errorstring | nullrequired
  • file_namestring | nullrequired
  • finished_atstring (date-time) | nullrequired
  • idintegerrequired
  • kindstringrequired

    Job kind: index (indexing). org_export jobs are not shown in job lists.

  • progressintegerrequired

    ≥ 0, ≤ 100

  • queued_atstring (date-time)required
  • resultobjectrequired
    Fields
    • failed_phasestring

      Processing phase in which the job failed (failed jobs only): the same values as phase. The list can grow.

      Allowed values: queuedreadingclassifyingreviewindexingdonefailedcanceled

    • pagesinteger
    • parserstring

      Document parser as a neutral code: document (full structure: pages, headings, tables, scanned pages), pdf (the PDF text layer), docx, xlsx, csv, markdown, html, text. The list can grow.

    • tablesnumber
  • retryablebooleanrequired
  • reviewboolean
  • review_expires_atstring (date-time) | null
  • reviewableboolean
  • reviewedboolean
  • sizeinteger | nullrequired
  • started_atstring (date-time) | nullrequired
  • statusJobStatusrequired
  • timingsobjectrequired
    Fields
    • total_snumber
  • titlestring | nullrequired
  • updated_atstring (date-time)required
  • user_idinteger | nullrequired
  • phasestring

    Processing phase (the list can grow): queued, reading (the document and its tables are read), classifying (the document type and category are determined), review (waiting for a review), indexing (the document is prepared for search), done, failed, canceled.

    Allowed values: queuedreadingclassifyingreviewindexingdonefailedcanceled

Part of

CardJobActionResultJobStreamJobJobStreamSnapshotJobWithCardJobsResponseReindexResultTextCardResultUploadResult