Skip to main content
Sign Out

Welcome to Dell

My Account
  • Place orders quickly and easily
  • View orders and track your shipping status
  • Enjoy members-only rewards and discounts
  • Create and access a list of your products
  • Manage your Dell EMC sites, products, and product-level contacts using Company Administration.
Sign In Create an Account Dell Financial Services Premier Sign In Partner Program Sign In
Contact Us

Your Dell.com Carts

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

PDF

GET method for Jobs

This method returns the details of all the jobs.

Description
Returns details of all the jobs.
Privilege
VIEW
HTTP response codes
200
Example response body 
{
  "@odata.context": "/api/$metadata#Collection(JobService.Job)",
  "@odata.count": 1,
  "value":
  [
    {
      "@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. FiltersThis table lists the filters that this URI supports.
Filter name Description
Top Top records to return. Default value is 100.
Skip Max records to skip. Default value is 0.
JobType/Id Filter by job type.
JobStatus/Id Filter by job status.
LastRunStatus/Id Filter by last run status.
State Filter by job state.
JobType/Internal Filter by job internal status.
Visible Filter by group visibility
NextRunBegin Filter by job next run time start.
NextRunEnd Filter by next run time end.
LastRunBegin Filter by last run time start.
LastRunEnd Filter by last run time end.
Table 2. 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.

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\