Extreme Networks Logo
Documentation Powered by ReDoc

ExtremeLocation Scheduler APIs (1.0.0)

Download OpenAPI specification:Download

Extreme Networks Support: support@extremenetworks.com URL: https://www.extremenetworks.com

ExtremeLocation Scheduler APIs allow you to programmatically manage schedules to send offline periodic dashboard reports in CSV and PDF format.

ExtremeLocation User Documentation

Scheduler API

Create schedule

This API provides option to create a schedule to be executed for the given context. This API requires following parameters: Name of schedule, Dashboard details, scope ,frequency, exportFormat

Request Body schema: application/json

Schedule object containing details to create the schedule.

get_id
string
dashboard
string
name
string
frequency
string
Enum: "DAILY" "WEEKLY" "MONTHLY"
scope
string
Enum: "ALL" "SITEGROUP" "SITE"
scopeId
string
scopeName
string
format
string
Value: "PDF"
emails
Array of strings
lastExecuted
string <date-time>
lastExecutedString
string <date-time>

Responses

200

Scheduled added successfully

400

Bad Request

404

Error create the schedule

post /schedule
https://manage.extremelocation.com/eloc-api/scheduler/schedule

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "get_id": "string",
  • "dashboard": "string",
  • "name": "string",
  • "frequency": "DAILY",
  • "scope": "ALL",
  • "scopeId": "string",
  • "scopeName": "string",
  • "format": "PDF",
  • "emails":
    [
    ],
  • "lastExecuted": "2019-08-15T19:56:53Z",
  • "lastExecutedString": "2019-08-15T19:56:53Z"
}

Delete schedule

This API is executed when any existing schedule needs to be deleted. It requires the schedule ID to be provided as parameter.

query Parameters
_id
required
string

Contains the ID of the schedule to be deleted.

Responses

200

Schedule with specified ID removed successfully

400

Bad Request

404

Error while deleting the schedule

delete /schedule
https://manage.extremelocation.com/eloc-api/scheduler/schedule