Search jobs

This endpoint is used to fetch the list of jobs defined by a tenant.

Leave Feedback

URL

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

Sample URLs

https://{api-url}/api/v2/tenants/client_93/jobs/search
https://{api-url}/api/v2/tenants/msp_92/jobs/search

Parameters

All parameters are optional:

ParameterDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
isDescendingOrder={true/false}true
sortName={field}id
queryString={queryString}NA

This API can be used to fetch the paginated list of the scheduled jobs of a partner or client.

Status code

200 OK

Sample response

{
	"results": [{
			"name": "test",
			"schedule": {
				"startDate": "2016-04-14T10:10:00+0000",
				"pattern": {
					"type": "daily",
					"frequency": "recurrence",
					"repeatFrequency": 2,
					"repeatType": "days"
				}
			},
			"jobQueued": true,
			"script": {
				"jobType": "appinstall",
				"approvalType": {
					"approvalType": 1,
					"approvalReason": "for testing",
					"alertRequired": true
				}
			},
			"id": "8a87f644-0bdc-4d5a-9e41-0ca333b71acd"
		},
		{
			"name": "Network Config Backup",
			"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"
		},
		{
			"name": "Job - test script",
			"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"
					]
				},
				"userType": 2
			},
			"id": "ce1088d5-81cc-4262-b515-a75230f0d8e4"
		},
		{
			"name": "Ad Check List",
			"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"
		}
	],
	"totalResults": 4,
	"orderBy": "job.name",
	"pageNo": 1,
	"pageSize": 10,
	"totalPages": 1,
	"nextPage": false,
	"previousPageNo": 0,
	"descendingOrder": true
}