Get the status of a bulk job

Get the status of a bulk job

Query Parameters

• job_id string required

  The id of the job returned from a POST or PATCH endpoint that resulted in a job being created

  Example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e

Responses

• 200
• 400
• 500

---

Expected response to a valid request

application/json

• Schema
• Example (from schema)

---

Schema

• uid uuid
• status string
• job_type string
• job_data object[]

  user_id uuid

  manager_id uuid

  errors string[]

{
  "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "complete",
  "job_type": "import",
  "job_data": [
    {
      "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "manager_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "errors": [
        "Validation error for record in job"
      ]
    }
  ]
}

Bad Request - unable to complete.

application/json

• Schema
• Example (from schema)

---

Schema

oneOf
• MOD1
• MOD2
---
error
error
errors

{
  "error": "Invalid JSON syntax. Please check your syntax and try again."
}

Internal Server Error - returned on unhandled exceptions.

application/json

• Schema
• Example (from schema)

---

Schema

• error

  A message describing the error

{
  "error": "Sorry something went wrong"
}

Loading...