BulkJobRead

Fields

15 fields

bulk_job_id · required

string

cancelled_at

string (date-time) or null

counters_source · required

string

created_at

string (date-time) or null

matched

integer or null

not_found

integer or null

note

string or null

progress · required

BulkJobProgress

queued

integer or null

requested

integer or null

skipped_in_progress

integer or null

source · required

string

state · required

string

truncated

boolean

workflow_type · required

string

Raw schema (JSON)

{
  "properties": {
    "bulk_job_id": {
      "title": "Bulk Job Id",
      "type": "string"
    },
    "cancelled_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Cancelled At"
    },
    "counters_source": {
      "title": "Counters Source",
      "type": "string"
    },
    "created_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created At"
    },
    "matched": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Matched"
    },
    "not_found": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Not Found"
    },
    "note": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Note"
    },
    "progress": {
      "$ref": "#/components/schemas/BulkJobProgress"
    },
    "queued": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Queued"
    },
    "requested": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Requested"
    },
    "skipped_in_progress": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Skipped In Progress"
    },
    "source": {
      "title": "Source",
      "type": "string"
    },
    "state": {
      "title": "State",
      "type": "string"
    },
    "truncated": {
      "default": false,
      "title": "Truncated",
      "type": "boolean"
    },
    "workflow_type": {
      "title": "Workflow Type",
      "type": "string"
    }
  },
  "required": [
    "bulk_job_id",
    "workflow_type",
    "source",
    "state",
    "counters_source",
    "progress"
  ],
  "title": "BulkJobRead",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

• GET /api/v1/agents/pipelines/bulk-jobs/{bulk_job_id} — Get Bulk Job
• POST /api/v1/agents/pipelines/bulk-jobs/{bulk_job_id}/cancel — Cancel Bulk Job

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON