Jump to

• Request
• Response

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

• count(optional): integer
  Maximum Value: 200

  Get the number of last events

  Default Value: 100
• for(optional): string
  job created on a specific date
• from(optional): string
  job created on and after a specific date
• head(optional): integer
  Minimum Value: 1

  Maximum Value: 200

  Get the number of oldest jobs
• keyword(optional): string
  Keyword that job description contains
• status(optional): string
  job status
• tail(optional): integer
  Minimum Value: 1

  Maximum Value: 200

  Get the number of latest jobs
• to(optional): 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(optional): string(date-time)
• description(optional): string
• jobId(optional): string
• message(optional): string
• status(optional): 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"
        },
        "description":{
            "type":"string"
        }
    }
}

Default Response

An unexpected error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
• message: string

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

Back to Top