Previous Next JavaScript must be enabled to correctly display this content

## Get jobs

get

/jobs

List all jobs, job details and status of each job. Job details includes the job IDs, status, the job created date and time stamp, etc. Use optional parameters to filter the job results

### Request

Supported Media Types

- application/json

Query Parameters

- all: boolean
  jobs created by both DCS and Error Correlation framework
- count: integer
  Maximum Value: `200`
  Get the number of last events
  Default Value: `100`
- descriptionPattern: string
  filter jobs by their description
- ec: boolean
  jobs created by Error Correlation framework
- for: string
  job created on a specific date
- from: string
  job created on and after a specific date
- head: integer
  Minimum Value: `1`
  Maximum Value: `200`
  Get the number of oldest jobs
- last: string
  jobs created until a certain time
- messagePattern: string
  filter jobs by their message
- notMatchDescriptionPattern: string
  filter jobs that do not match their description
- notMatchMessagePattern: string
  filter jobs that do not match their message
- status: string
  job status
- tail: integer
  Minimum Value: `1`
  Maximum Value: `200`
  Get the number of latest jobs
- to: string
  job created on and before a specific date

Back to Top

### Response

Supported Media Types

- application/json

#### 200 Response

Ok
Body ()
Root Schema : schema
Type: `array`
Show Source

- Array of: object ServiceJobReportSummary
  Job Request summary

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/ServiceJobReportSummary"
        }
    }

Nested Schema : ServiceJobReportSummary
Type: `object`
Job Request summary
Show Source

- createTimestamp: string(date-time)
- description: string
- duration: string
- jobId: string
- jobType: string
- message: string
- status: string
  Allowed Values: `[ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure" ]`

    {
        "description":"Job Request summary",
        "properties":{
            "jobId":{
                "type":"string"
            },
            "status":{
                "type":"string",
                "enum":[
                    "Created",
                    "Scheduled",
                    "Running",
                    "Success",
                    "Failure",
                    "Retrying",
                    "Waiting",
                    "InternalError",
                    "Reverting",
                    "Reverted",
                    "NodeDisconnectedFailure"
                ]
            },
            "message":{
                "type":"string"
            },
            "createTimestamp":{
                "type":"string",
                "format":"date-time"
            },
            "duration":{
                "type":"string"
            },
            "description":{
                "type":"string"
            },
            "jobType":{
                "type":"string"
            }
        }
    }

#### Default Response

An unexpected error has occurred
Body ()
Root Schema : Error
Type: `object`
Show Source

- code(required): string
- message(required): string

    {
        "required":[
            "code",
            "message"
        ],
        "properties":{
            "code":{
                "type":"string"
            },
            "message":{
                "type":"string"
            }
        }
    }

Back to Top