Get the status of a bulk job

GET 
/job_status

Get the status of a bulk job

Request

Query Parameters

job_id stringrequired

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

Responses

200

Expected response to a valid request

application/json

Schema

Schema

uid uuid
status string
job_type string
job_data object[]
Array [
user_id uuid
manager_id uuid
errors string[]
]

Example (from schema)

{
  "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"
      ]
    }
  ]
}

400

Bad Request - unable to complete.

application/json

Schema

Schema

oneOf
InvalidJson
error
ValidationErrors
error
errors

Example (from schema)

{}

500

Internal Server Error - returned on unhandled exceptions.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

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

Loading...