OpenManage Enterprise Version 3.4 and OpenManage Enterprise - Modular Edition Version 1.20.00 RESTful API Guide

PDF

GET method for JobStatuses

This method returns the status of all the jobs.

Description

Returns status of all the jobs.

Privilege

VIEW

HTTP response codes

200

Example response body

{
  "@odata.context": "/api/$metadata#Collection(JobService.JobStatus)",
  "@odata.count": 12,
  "value":
  [
    {
      "@odata.type": "#JobService.JobStatus",
      "@odata.id": "/api/JobService/JobStatuses(2020)",
      "Id": 2020,
      "Name": "Scheduled"
    },
    {
      "@odata.type": "#JobService.JobStatus",
      "@odata.id": "/api/JobService/JobStatuses(2030)",
      "Id": 2030,
      "Name": "Queued"
    },
    {
      "@odata.type": "#JobService.JobStatus",
      "@odata.id": "/api/JobService/JobStatuses(2040)",
      "Id": 2040,
      "Name": "Starting"
    },
    {
      "@odata.type": "#JobService.JobStatus",
      "@odata.id": "/api/JobService/JobStatuses(2050)",
      "Id": 2050,
      "Name": "Running"
    },
    {
      "@odata.type": "#JobService.JobStatus",
      "@odata.id": "/api/JobService/JobStatuses(2060)",
      "Id": 2060,
      "Name": "Completed"
    },
    {
      "@odata.type": "#JobService.JobStatus",
      "@odata.id": "/api/JobService/JobStatuses(2070)",
      "Id": 2070,
      "Name": "Failed"
    },
    {
      "@odata.type": "#JobService.JobStatus",
      "@odata.id": "/api/JobService/JobStatuses(2080)",
      "Id": 2080,
      "Name": "New"
    },
    {
      "@odata.type": "#JobService.JobStatus",
      "@odata.id": "/api/JobService/JobStatuses(2090)",
      "Id": 2090,
      "Name": "Warning"
    },
    {
      "@odata.type": "#JobService.JobStatus",
      "@odata.id": "/api/JobService/JobStatuses(2100)",
      "Id": 2100,
      "Name": "Aborted"
    },
    {
      "@odata.type": "#JobService.JobStatus",
      "@odata.id": "/api/JobService/JobStatuses(2101)",
      "Id": 2101,
      "Name": "Paused"
    },
    {
      "@odata.type": "#JobService.JobStatus",
      "@odata.id": "/api/JobService/JobStatuses(2102)",
      "Id": 2102,
      "Name": "Stopped"
    },
    {
      "@odata.type": "#JobService.JobStatus",
      "@odata.id": "/api/JobService/JobStatuses(2103)",
      "Id": 2103,
      "Name": "Canceled"
    }
  ]
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute	Description
Id	ID of the job status.
Name	Name of the job status.