Documentation is now available for the Fall 2020 Update release!

Get job

This endpoint is used to retrieve the job details.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/jobs/{id}

Sample URLs

https://{api-url}/api/v2/tenants/client_93/jobs/ce1088d5-81cc-4262-b515-a75230f0d8e4

Status code

200 OK

Job type - AD checklist

Sample URL

https://{api-url}/api/v2/tenants/msp_11/jobs/8a87f644-0bdc-4d5a-9e41-0ca333b71acd
api/v2/tenants/client_93/jobs/ce1088d5-81cc-4262-b515-a75230f0d8e4

Sample response

{
	"name": "Ad Check List",
	"entities": [{
			"resource": {
				"id": "4e96d5bc-763c-4c00-beab-928d653a0422",
				"generalInfo": {
					"ipAddresses": "172.30.1.60",
					"hostName": "172.30.1.60",
                                        "resourceType": "Desktop",
                                        "resourceName": "abc",
                                        "aliasName": ""
				},
				"clientUniqueId": "client_13",
				"type": "DEVICE"
			}
		},
		{
			"resource": {
				"id": "709824de-8315-4cf9-ad1c-b15aaf7bf2a5",
				"generalInfo": {
					"ipAddresses": "10.233.19.130",
					"hostName": "10.233.19.130",
                                        "resourceType": "Desktop",
                                        "resourceName": "abcd",
                                        "aliasName": ""
				},
				"clientUniqueId": "client_13",
				"type": "DEVICE"
			}
		}
	],
	"schedule": {
		"startDate": "2016-04-14T10:10:00+0000",
		"pattern": {
			"type": "daily",
			"frequency": "recurrence",
			"repeatFrequency": 2,
			"repeatType": "days"
		}
	},
	"jobQueued": true,
	"script": {
		"jobType": "adCheckList"
	},
	"id": "4902d87c-b5df-4797-9f45-e807cd871ac9"
}

Job type - script

Sample URL

https://{api-url}/api/v2/tenants/client_93/jobs/ce1088d5-81cc-4262-b515-a75230f0d8e4

Sample response

{
	"name": "Job - test script",
	"entities": [{
			"resource": {
				"id": "4e96d5bc-763c-4c00-beab-928d653a0422",
				"generalInfo": {
					"ipAddresses": "172.30.1.60",
					"hostName": "172.30.1.60"
				},
				"clientUniqueId": "client_13",
				"type": "DEVICE"
			}
		},
		{
			"resource": {
				"id": "709824de-8315-4cf9-ad1c-b15aaf7bf2a5",
				"generalInfo": {
					"ipAddresses": "10.233.19.130",
					"hostName": "10.233.19.130"
				},
				"clientUniqueId": "client_13",
				"type": "DEVICE"
			}
		}
	],
	"schedule": {
		"startDate": "2016-04-14T10:10:00+0000",
		"pattern": {
			"type": "daily",
			"frequency": "recurrence",
			"repeatFrequency": 2,
			"repeatType": "days"
		}
	},
	"jobQueued": true,
	"script": {
		"customScript": {
			"id": 7,
			"name": "test script",
			"description": "test script",
			"platforms": [
				"WINDOWS"
			]
		},
		"parameters": [{
			"paramId": 2,
			"name": "String",
			"value": "150"
		}],
		"userType": 2
	},
	"id": "ce1088d5-81cc-4262-b515-a75230f0d8e4"
}

Job type - network backup configuration

Sample URL

https://{api-url}/api/v2/tenants/client_11/jobs/cc242a8d-b0b4-430e-a89f-7081bc5e79b0

Sample response

{
	"name": "Network Config Backup",
	"entities": [{
			"resource": {
				"id": "4e96d5bc-763c-4c00-beab-928d653a0422",
				"generalInfo": {
					"ipAddresses": "172.30.1.60",
					"hostName": "172.30.1.60"
				},
				"clientUniqueId": "client_13",
				"type": "DEVICE"
			}
		},
		{
			"resource": {
				"id": "709824de-8315-4cf9-ad1c-b15aaf7bf2a5",
				"generalInfo": {
					"ipAddresses": "10.233.19.130",
					"hostName": "10.233.19.130"
				},
				"clientUniqueId": "client_13",
				"type": "DEVICE"
			}
		}
	],
	"schedule": {
		"startDate": "2016-04-14T10:10:00+0000",
		"pattern": {
			"type": "daily",
			"frequency": "recurrence",
			"repeatFrequency": 2,
			"repeatType": "days"
		}
	},
	"jobQueued": true,
	"script": {
		"jobType": "networkconfigbackup",
		"configParams": {
			"versionsSaved": "ALL_VERSIONS",
			"backUpTrigger": true,
			"startupConfigAlert": true,
			"runtimeConfigAlert": true,
			"startUpConfigFilesBackUp": true,
			"runTimeConfigFilesBackUp": true
		}
	},
	"id": "cc242a8d-b0b4-430e-a89f-7081bc5e79b0"
}