Table of Contents

Schedule refresh for a Vizpad

Ramya Priya Updated by Ramya Priya

The following APIs can be used to refresh a Vizpad at regular intervals. The first API returns the task ID, using which a schedule can be set up for refreshing the required Vizpad.

Create a task ID

Request

URL

Replace vizpad_id with the ID of the Vizpad which needs to be refreshed regularly.

https://<TelliusUrl>/api/load/refresh/<vizpad_id>/schedule
CURL
curl -v -H "Content-Type: application/json" \
		-H "Authorization:<AUTHENTICATION_TOKEN_FROM_LOGIN_API>" \
		https://<tellius>/api/load/refresh/<vizpadId>/schedule \
		--data '{"options":{"objectType":"vizpad"}}'
Method
POST
Headers

By default, only superUsers can access this view.

Authorization: Bearer <AUTHENTICATION_TOKEN_FROM_LOGIN_API>
Content-Type: application/json, text/plain
Body
{
  "options":
  {
    "objectType":"vizpad"
  }
}

Response

Success
Status Code: 200 OK
Body

The response body will contain the task ID for the scheduled refresh task for the specified Vizpad. The task ID can be used to schedule the task, check the status of the task, or to cancel the task if needed.

{
"taskid":"ee661a34-604e75086bbb"
}

Schedule the refresh

The task-id obtained from the previous API can be used to set the schedule for refresh.

Request

URL
https://<TelliusUrl>/api/schedule
CURL
curl -v -H "Content-Type: application/json" \
		-H "Authorization:<AUTHENTICATION_TOKEN_FROM_LOGIN_API>" \
		https://<tellius>/api/schedule
		--data '{"id":"ee661a34-1a2f-4732-9d34-604e75086bbb","name":"","startdate":"12/13/2019","starttime":"9,43,pm,GMT+05:30 (India Standard Time)","frequency":"1","frequencyunit":"d"}'
Method
POST
Headers

By default, only superUsers can access this view.

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

The request body contains the details for scheduling a refresh task, including the id of the task, name of the schedule, startdate, starttime, frequency and frequencyunit for the schedule.

{
"id": "ee661a34-604e75086bbb",
"name": "schedule_name",
"startdate": "12/13/2019",
"starttime": "9,43,pm,GMT+05:30 (India Standard Time)",
"frequency": "1",
"frequencyunit": "d"
}

Response

Success
Status Code: 200 OK
Body

The response body returns the ID of the schedule created.

{
"scheduleId": "46777-2af9adea2287"
}

Did we help you?

Schedule reports for a Vizpad

Get scheduled jobs for a Vizpad

Contact