List batch operations

GET 
/v2/projects/:projectId/batch-jobs

List batch operations

Request

Path Parameters

projectId int64required

Query Parameters

page integer

Default value: 0

Zero-based page index (0..N)

size integer

Possible values: >= 1

Default value: 20

The size of the page to be returned

sort string[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

200

OK

application/json

Schema

Schema

_embedded object
batchJobs object[]
Array [
id int64required
Batch job id
status stringrequired
Possible values: [PENDING, RUNNING, SUCCESS, FAILED, CANCELLED, DEBOUNCED]
Status of the batch job
type stringrequired
Possible values: [PRE_TRANSLATE_BT_TM, MACHINE_TRANSLATE, AUTO_TRANSLATE, DELETE_KEYS, SET_TRANSLATIONS_STATE, CLEAR_TRANSLATIONS, COPY_TRANSLATIONS, TAG_KEYS, UNTAG_KEYS, SET_KEYS_NAMESPACE, AUTOMATION]
Type of the batch job
progress int32required
Total items, that have been processed so far
totalItems int32required
Total items
author object
User who created the comment
id int64required
username stringrequired
name string
avatar object
large stringrequired
thumbnail stringrequired
deleted booleanrequired
createdAt int64required
The time when the job created
updatedAt int64required
The time when the job was last updated (status change)
activityRevisionId int64
The activity revision id, that stores the activity details of the job
errorMessage string
If the job failed, this is the error message
]
page object
size int64
totalElements int64
totalPages int64
number int64

Example (from schema)

{
  "_embedded": {
    "batchJobs": [
      {
        "id": 0,
        "status": "PENDING",
        "type": "PRE_TRANSLATE_BT_TM",
        "progress": 0,
        "totalItems": 0,
        "author": {
          "id": 0,
          "username": "string",
          "name": "string",
          "avatar": {
            "large": "string",
            "thumbnail": "string"
          },
          "deleted": true
        },
        "createdAt": 0,
        "updatedAt": 0,
        "activityRevisionId": 0,
        "errorMessage": "string"
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

400

Bad Request

*/*

Schema

Schema

string

401

Unauthorized

*/*

Schema

Schema

string

403

Forbidden

*/*

Schema

Schema

string

404

Not Found

*/*

Schema

Schema

string

Loading...