# List of jobs

List of jobs in queue. Using the "status" parameter to filter by completed|pending|running|failed|expired|killed. 
Without this filter it will show all statuses. Also you can filter results depends on time of creation and completion.

Endpoint: GET /api/system/jobs
Version: 1.0.0
Security: shoptetAccessToken, shoptetPrivateApiToken

## Query parameters:

  - `status` (string)
    supported values: completed, pending, running, failed,
expired, killed
    Example: "completed"

  - `creationTimeFrom` (string)
    date and time of job creation - lower limit
    Example: "2018-05-28T14:17:00+02:00"

  - `creationTimeTo` (string)
    date and time of job creation - upper limit
    Example: "2018-05-28T14:17:00+02:00"

  - `completionTimeFrom` (string)
    date and time of job completion - lower limit
    Example: "2018-05-28T14:17:00+02:00"

  - `completionTimeTo` (string)
    date and time of job completion - upper limit
    Example: "2018-05-28T14:17:00+02:00"

  - `itemsPerPage` (integer)
    Returned items per page. Default value is 100. Max value is 500.
    Example: 50

  - `page` (integer)
    Page number to return. Default value is 1.
    Example: 3

## Header parameters:

  - `Content-Type` (string, required)

## Response 200 fields (application/json):

  - `data` (object, required)

  - `data.jobs` (array, required)

  - `data.jobs.jobId` (string, required)
    job unique code.

  - `data.jobs.endpoint` (string, required)
    called endpoint by service

  - `data.jobs.creationTime` (string,null, required)
    time of job creation

  - `data.jobs.completionTime` (string,null, required)
    time of job completion

  - `data.jobs.status` (string, required)
    job status

  - `data.jobs.validUntil` (string,null, required)
    validity of job result

  - `data.jobs.language` (string,null)
    Available only if module Foreign languages is active and initialized.

  - `data.paginator` (object, required)

  - `data.paginator.totalCount` (integer, required)
    total number of available records

  - `data.paginator.page` (integer, required)
    current page

  - `data.paginator.pageCount` (integer, required)
    total available of pages

  - `data.paginator.itemsOnPage` (integer, required)
    number of currently returned records

  - `data.paginator.itemsPerPage` (integer, required)
    required number of records per page

  - `errors` (array,null, required)

  - `errors.errorCode` (string, required)
    Short text error identification

  - `errors.message` (string, required)
    Descriptive error message

  - `errors.instance` (string, required)
    Identification of the entity referenced

  - `metadata` (object, required)

  - `metadata.requestId` (string, required)
    Request identifier. Useful for logging/reporting purposes.