Get Batch Import Job Details

Version: v2

Get the status for a batch user import job with job details.

This call is a step in an asynchronous workflow.

Path Parameters

job_id string required

ID that can be used to check the status and retrieve results for the batch import

Responses

200

A successful response.

Schema

Example

Schema

imports int32 required

The stats on the number of items imported successfully

errors int32 required

Only included for failed imports. The stats on the number of items that failed to be imported

job object required

Information about the current state of the job

id string required

ID of the job.

status string required

Possible values: [PROCESSING, COMPLETED, FAILED]

Status of the job.

created date-time required

Time the job was accepted.

finished date-time optional

Time the job was finished, either successfully or unsuccessfully.

{
  "imports": 42,
  "errors": 2,
  "job": {
    "id": "abd123=",
    "status": "FAILED",
    "created": "2019-04-18T14:36:11.123Z",
    "finished": "2019-04-18T15:36:11.123Z"
  }
}

Returned when invalid input has been provided. Fix the issue and retry.

Schema

Example

{
  "message": "uid is required",
  "code": "required_field"
}

Returned when access to the resource is unauthorized.

Schema

Example

{
  "message": "access is unauthorized",
  "code": "unauthorized"
}

Returned when access is not allowed due to insufficient permissions.

Schema

Example

{
  "message": "insufficient permissions",
  "code": "forbidden"
}

Returned when the resource does not exist.

Schema

Example

{
  "message": "Requested resource does not exist",
  "code": "resource_not_found"
}

Returned when the client has exceeded the rate limit for this endpoint. A Retry-After header will be included with the response. This header will contain the number of seconds that you should wait before attempting to send another request.

Schema

Example

{
  "message": "Too many requests. Client has exceeded the rate limit for this endpoint.",
  "code": "too_many_requests"
}

Returned when a server error is encountered

Schema

Example

{
  "message": "Server error was encountered",
  "code": "server_error"
}

Get Batch Import Job Details​

Get Batch Import Job Details