OpenManage Enterprise Version 3.2 and OpenManage Enterprise - Modular Edition Version 1.00.10 RESTful API Guide

PDF

GET method for Jobs(Id)

This method returns the details of a specific job.

Description

Returns details of a job.

Privilege

VIEW

HTTP response codes

200

Example

Input:

Output:	
{
  "@odata.context": "/api/$metadata#JobService.Job/$entity",
  "@odata.type": "#JobService.Job",
  "@odata.id": "/api/JobService/Jobs(10016)",
  "Id": 10016,
  "JobName": "Default Inventory Task",
  "JobDescription": "Default Inventory Task",
  "NextRun": "2018-09-14 15:30:00.0",
  "LastRun": "2018-09-14 15:00:00.381",
  "StartTime": null,
  "EndTime": null,
  "Schedule": "0 0/30 * 1/1 * ? *",
  "State": "Enabled",
  "CreatedBy": "admin",
  "UpdatedBy": null,
  "Visible": false,
  "Editable": false,
  "Builtin": true,
  "Targets":
  [
    {
      "JobId": 10016,
      "Id": 500,
      "Data": "All-Devices",
      "TargetType":
      {
        "Id": 6000,
        "Name": "GROUP"
      }
    }
  ],
  "Params":
  [
    {
      "JobId": 10016,
      "Key": "defaultInventoryTask",
      "Value": "TRUE"
    }
  ],
  "LastRunStatus":
  {
    "@odata.type": "#JobService.JobStatus",
    "Id": 2060,
    "Name": "Completed"
  },
  "JobType":
  {
    "@odata.type": "#JobService.JobType",
    "Id": 8,
    "Name": "Inventory_Task",
    "Internal": false
  },
  "JobStatus":
  {
    "@odata.type": "#JobService.JobStatus",
    "Id": 2020,
    "Name": "Scheduled"
  },
  "ExecutionHistories@odata.navigationLink": "/api/JobService/Jobs(10016)/ExecutionHistories"
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute	Description
Id	ID of the job.
JobName	Name of the job.
JobDescription	Description of the job.
JobType	Type of the job.
NextRun	The next time when the job will be executed.
LastRun	The last time when the job was executed.
StartTime	Start time of the job.
EndTime	End time of the job.
Schedule	Job schedule (cron string).
State	Indicates whether the job is enabled or disabled.
CreatedBy	User who created the job.
UpdatedBy	User who updated the job.
Visible	Indicates whether the job is visible.
Editable	Indicates whether the job can be edited.
BuiltIn	Indicates if the job is internal.
Targets	Job targets.
Params	Parameters for the job.
LastRunStatus	Indicates the status of the last instance of the job execution.
JobStatus	Job completion status. 2020 — Scheduled 2030 — Queued 2040 — Starting 2050 — Running 2060 — Completed 2070 — Failed 2080 — New 2090 — Warning 2100 — Aborted 2101 — Paused 2102 — Stopped 2103 — Canceled
Links	Link to access all execution histories.