BulkJobProgress

Fields

6 fields

completed · required

integer

failed · required

integer

in_progress · required

integer

not_started

integer or null

passed · required

integer

started · required

integer

Raw schema (JSON)

{
  "properties": {
    "completed": {
      "title": "Completed",
      "type": "integer"
    },
    "failed": {
      "title": "Failed",
      "type": "integer"
    },
    "in_progress": {
      "title": "In Progress",
      "type": "integer"
    },
    "not_started": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Not Started"
    },
    "passed": {
      "title": "Passed",
      "type": "integer"
    },
    "started": {
      "title": "Started",
      "type": "integer"
    }
  },
  "required": [
    "started",
    "in_progress",
    "completed",
    "passed",
    "failed"
  ],
  "title": "BulkJobProgress",
  "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

• BulkJobRead

More details

• Specification: OpenAPI JSON