Dell EMC OpenManage Enterprise 3.9 RESTful API Guide

PDF

GET method for Jobs

This method returns the discovery job information with discovery request details.

Description

Returns the discovery job information.

Privilege

VIEW

HTTP response codes

200

Example response body

{
    "@odata.context": "/api/$metadata#Collection(DiscoveryConfigService.DiscoveryJob)",
    "@odata.count": 5,
    "value": [
        {
            "@odata.type": "#DiscoveryConfigService.DiscoveryJob",
            "@odata.id": "/api/DiscoveryConfigService/Jobs(25249)",
            "JobId": 25249,
            "JobName": "Discovery-2017033110553636",
            "JobDescription": "Discovery-2017033110553636",
            "JobSchedule": "",
            "JobStartTime": "2018-09-14 01:24:25.322",
            "JobEndTime": null,
            "JobProgress": "89",
            "JobStatusId": 2050,
            "JobNextRun": null,
            "JobEnabled": true,
            "UpdatedBy": "admin",
            "LastUpdateTime": "2018-09-14 01:24:25.338",
            "DiscoveryConfigGroupId": 8,
            "DiscoveryConfigExpectedDeviceCount": 256,
            "DiscoveryConfigDiscoveredDeviceCount": 0,
            "DiscoveryConfigEmailRecipient": null,
            "DiscoveredDevicesByType": []
        },
        {
            "@odata.type": "#DiscoveryConfigService.DiscoveryJob",
            "@odata.id": "/api/DiscoveryConfigService/Jobs(25125)",
            "JobId": 25125,
            "JobName": "Discovery-201809131357033",
            "JobDescription": "Discovery-201809131357033",
            "JobSchedule": "",
            "JobStartTime": "2018-09-13 18:57:19.374",
            "JobEndTime": "2018-09-13 19:12:24.776",
            "JobProgress": "100",
            "JobStatusId": 2090,
            "JobNextRun": "2018-09-13 18:57:19.235",
            "JobEnabled": true,
            "UpdatedBy": "admin",
            "LastUpdateTime": "2018-09-13 19:12:24.777",
            "DiscoveryConfigGroupId": 7,
            "DiscoveryConfigExpectedDeviceCount": 256,
            "DiscoveryConfigDiscoveredDeviceCount": 31,
            "DiscoveryConfigEmailRecipient": null,
            "DiscoveredDevicesByType": [
                {
                    "DeviceType": "SERVER",
                    "Count": 31
                }
            ]
        },
        {
            "@odata.type": "#DiscoveryConfigService.DiscoveryJob",
            "@odata.id": "/api/DiscoveryConfigService/Jobs(25120)",
            "JobId": 25120,
            "JobName": "Amit",
            "JobDescription": "Amit",
            "JobSchedule": "",
            "JobStartTime": "2018-09-13 16:48:22.428",
            "JobEndTime": "2018-09-13 00:00:00.0",
            "JobProgress": "100",
            "JobStatusId": 2102,
            "JobNextRun": "2018-09-13 16:25:04.174",
            "JobEnabled": true,
            "UpdatedBy": "admin",
            "LastUpdateTime": "2018-09-13 16:48:22.454",
            "DiscoveryConfigGroupId": 6,
            "DiscoveryConfigExpectedDeviceCount": 101,
            "DiscoveryConfigDiscoveredDeviceCount": 0,
            "DiscoveryConfigEmailRecipient": null,
            "DiscoveredDevicesByType": []
        },
        {
            "@odata.type": "#DiscoveryConfigService.DiscoveryJob",
            "@odata.id": "/api/DiscoveryConfigService/Jobs(25116)",
            "JobId": 25116,
            "JobName": "Discovery-2018091310582929",
            "JobDescription": "Discovery-2018091310582929",
            "JobSchedule": "",
            "JobStartTime": "2018-09-13 15:59:08.565",
            "JobEndTime": "2018-09-13 16:02:09.36",
            "JobProgress": "100",
            "JobStatusId": 2070,
            "JobNextRun": null,
            "JobEnabled": true,
            "UpdatedBy": "admin",
            "LastUpdateTime": "2018-09-13 16:02:09.361",
            "DiscoveryConfigGroupId": 5,
            "DiscoveryConfigExpectedDeviceCount": 256,
            "DiscoveryConfigDiscoveredDeviceCount": 0,
            "DiscoveryConfigEmailRecipient": null,
            "DiscoveredDevicesByType": []
        },
        {
            "@odata.type": "#DiscoveryConfigService.DiscoveryJob",
            "@odata.id": "/api/DiscoveryConfigService/Jobs(25099)",
            "JobId": 25099,
            "JobName": "Multiple",
            "JobDescription": "Multiple",
            "JobSchedule": "",
            "JobStartTime": "2018-07-26 19:35:01.976",
            "JobEndTime": "2018-07-26 19:36:34.075",
            "JobProgress": "100",
            "JobStatusId": 2060,
            "JobNextRun": "2018-07-26 19:20:04.796",
            "JobEnabled": true,
            "UpdatedBy": "admin",
            "LastUpdateTime": "2018-07-26 19:36:34.374",
            "DiscoveryConfigGroupId": 4,
            "DiscoveryConfigExpectedDeviceCount": 1,
            "DiscoveryConfigDiscoveredDeviceCount": 1,
            "DiscoveryConfigEmailRecipient": null,
            "DiscoveredDevicesByType": [
                {
                    "DeviceType": "SERVER",
                    "Count": 1
                }
            ]
        }
    ]
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute	Description
JobId	ID of the discovery job.
JobName	Name of the discovery job.
JobSchedule	Discovery job schedule information.
JobStartTime	Start time of the discovery job.
JobEndTime	Completion time of the discovery job.
JobProgress	Percentage of discovery job completion.
JobStatusId	Status of the discovery job. For example, Complete, Failed, and so on.
JobNextRun	If discovery job is scheduled, returns the next schedule time.
LastUpdateTime	Last updated time of the discovery job.
DiscoveryConfigExpectedDeviceCount	Total number of devices expected to be discovered by the job.
DiscoveryConfigDiscoveredDeviceCount	Total number of devices discovered by the job.