ImportSessionStatus

  • counts
    Type: object · TaskCounts
    required
    • deleted
      Type: integer

      DELETE mode only - assets soft-archived (deleted) by the batch.

    • failed
      Type: integer

      Integer numbers.

    • inserted
      Type: integer

      Integer numbers.

    • received
      Type: integer

      Integer numbers.

    • retired
      Type: integer

      FULL-sync only - assets soft-retired because they were absent from the batch.

    • skipped
      Type: integer

      Integer numbers.

    • updated
      Type: integer

      Integer numbers.

  • displayCode
    Type: string
    required

    Org-scoped short code for this import session, e.g. IMP-0006.

  • importSessionId
    Type: string
    required

    The import session id - the batch identity you poll and correlate on.

  • mode
    Type: string enum
    required
    values
    • INGEST
    • NORMALIZE
    • UPDATE
    • DELETE
  • progress
    Type: number
    required

    0..1 overall progress.

  • status
    Type: string enum
    required
    values
    • queued
    • processing
    • completed
    • failed
    • cancelled
  • batchLabel
    Type: string

    Human subtitle for the batch, when the session carries one.

  • completedAt
    Type: string | null Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • createdAt
    Type: string Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • error
    Type: string | null
  • issues
    Type: object

    INGEST / UPDATE / DELETE - paginated per-row outcomes. NORMALIZE - run-level notices only (per-row problems are inline on each normalizedRows entry).

    • data
      Type: array object[] · TaskIssue[]

      Top-level issue. For INGEST sessions, one per-row outcome; for NORMALIZE sessions, only run-level notices (e.g. normalization_skipped, issues_truncated) with rowIndex < 0. Per-row NORMALIZE problems are inline on each normalized row.

    • pagination
      Type: object · Pagination
  • normalizedRows
    Type: object

    Present for NORMALIZE sessions - cleaned rows (with inline issues), re-submittable to /assets/ingest.

    • data
      Type: array object[] · NormalizedRow[]
    • pagination
      Type: object · Pagination
  • progressPercent
    Type: integer

    Integer numbers.

  • syncMode
    Type: string | null enum
    values
    • DELTA
    • FULL
    • null
  • updatedAt
    Type: string Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z