Table of Contents

Get scheduled jobs for a Vizpad

Ramya Priya Updated by Ramya Priya

The APIs can be used to get the list of different scheduled jobs for the required Vizpad.

Request

URL

Replace vizpad_id with the ID of the Vizpad for which the scheduled jobs needs to be retrieved.

https://<TelliusUrl>/api/schedule?objectId=<vizpad_id>
CURL
curl -X 'GET' -v -H "Content-Type: application/json" \
		-H "Authorization:<AUTHENTICATION_TOKEN_FROM_LOGIN_API>" \
		https://<TelliusUrl>/api/schedule?<vizpadId>
Method
GET
Headers

By default, only superUsers can access this view.

Authorization: Bearer <AUTHENTICATION_TOKEN_FROM_LOGIN_API>
Content-Type: application/json, text/plain

Response

Success
Status Code: 200 OK
Body

This response body contains an array of scheduled jobs for the given vizpad.

{
	"scheduledJobs": [
		{
			"name": "name",
			"datasetId": "c4bea2fc-3aa279d8755a",
			"object": {
				"objectId": "c4bea2fc-3aa279d8755a",
				"objectType": "vizpad"
			},
			"id": "cec1c90e-a3baa5e1cd0b",
			"frequencyunit": "d",
			"scheduleId": "1ab8d204-daa27497abd3",
			"starttime": "05,33,AM,UTC",
			"createdBy": "1ecd87c8-b60691610784",
			"report": {
				"communication": {
					"email": {
						"to": [
							"a@b.com"
						]
					}
				},
				"type": "pdf",
				"title": "sample",
				"body": "sample"
			},
			"frequency": "1",
			"startdate": "12/19/2019"
		}
	]
}

Did we help you?

Schedule refresh for a Vizpad

Contact