GET/desk/api/v2/backgroundjobs/{jobId}.json

Get a background job by jobId.

Path Params

  • Name
    jobId
    Type
    integer
    required
    Description

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    BackgroundJobAPIBody handles the get/create/update request/response for backgroundjob.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

Examples

200 OK

BackgroundJobAPIBody
{  "backgroundjob": {    "completed": "string",    "createdAt": "string",    "description": "string",    "failed": 0,    "pending": 0,    "percent": 0,    "state": "string",    "succeed": "string",    "total": 0  },  "included": {    "addresses": [      {        "city": "string",        "country": "string",        "firstLine": "string",
Download Swagger