[Index]
Model ref.: device/spark/Schedules
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "A unique name for the schedule.",
"title": "Name"
},
"events": {
"items": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"description": "Start Date of Event.",
"title": "Start Date"
},
"endDate": {
"type": "string",
"description": "End Date of Event.",
"title": "End Date"
},
"name": {
"type": "string",
"description": "A unique name for the event.",
"title": "Name"
},
"allDayEnabled": {
"type": "boolean",
"description": "An indication of whether given event is an all-day event or not.",
"title": "All Day Enabled"
},
"recurrence": {
"properties": {
"recurForEver": {
"type": "boolean",
"description": "Flag to indicate if event will recur forever.",
"title": "Recur Forever"
},
"recurYearlyByDay": {
"properties": {
"week": {
"choices": [
{
"value": "FIRST",
"title": "FIRST"
},
{
"value": "SECOND",
"title": "SECOND"
},
{
"value": "THIRD",
"title": "THIRD"
},
{
"value": "FOURTH",
"title": "FOURTH"
},
{
"value": "LAST",
"title": "LAST"
}
],
"type": "string",
"description": "Schedule the event on a specific week.",
"title": "Week"
},
"day": {
"choices": [
{
"value": "SUNDAY",
"title": "SUNDAY"
},
{
"value": "MONDAY",
"title": "MONDAY"
},
{
"value": "TUESDAY",
"title": "TUESDAY"
},
{
"value": "WEDNESDAY",
"title": "WEDNESDAY"
},
{
"value": "THURSDAY",
"title": "THURSDAY"
},
{
"value": "FRIDAY",
"title": "FRIDAY"
},
{
"value": "SATURDAY",
"title": "SATURDAY"
}
],
"type": "string",
"description": "Schedule the event on a specific day.",
"title": "Day"
},
"month": {
"choices": [
{
"value": "JANUARY",
"title": "JANUARY"
},
{
"value": "FEBRUARY",
"title": "FEBRUARY"
},
{
"value": "MARCH",
"title": "MARCH"
},
{
"value": "APRIL",
"title": "APRIL"
},
{
"value": "MAY",
"title": "MAY"
},
{
"value": "JUNE",
"title": "JUNE"
},
{
"value": "JULY",
"title": "JULY"
},
{
"value": "AUGUST",
"title": "AUGUST"
},
{
"value": "SEPTEMBER",
"title": "SEPTEMBER"
},
{
"value": "OCTOBER",
"title": "OCTOBER"
},
{
"value": "NOVEMBER",
"title": "NOVEMBER"
},
{
"value": "DECEMBER",
"title": "DECEMBER"
}
],
"type": "string",
"description": "Schedule the event on a specific month.",
"title": "Month"
}
},
"required": false,
"type": "object",
"description": "Recur definition yearly by day.",
"title": "Recur Yearly by Day"
},
"recurEndDate": {
"type": "string",
"description": "End date of recurrence.",
"title": "Recurrence End Date"
},
"recurYearlyByDate": {
"properties": {
"month": {
"choices": [
{
"value": "JANUARY",
"title": "JANUARY"
},
{
"value": "FEBRUARY",
"title": "FEBRUARY"
},
{
"value": "MARCH",
"title": "MARCH"
},
{
"value": "APRIL",
"title": "APRIL"
},
{
"value": "MAY",
"title": "MAY"
},
{
"value": "JUNE",
"title": "JUNE"
},
{
"value": "JULY",
"title": "JULY"
},
{
"value": "AUGUST",
"title": "AUGUST"
},
{
"value": "SEPTEMBER",
"title": "SEPTEMBER"
},
{
"value": "OCTOBER",
"title": "OCTOBER"
},
{
"value": "NOVEMBER",
"title": "NOVEMBER"
},
{
"value": "DECEMBER",
"title": "DECEMBER"
}
],
"type": "string",
"description": "Schedule the event on a specific month of the year.",
"title": "Month"
},
"dayOfMonth": {
"type": "integer",
"description": "Schedule the event on a specific day of the month",
"title": "Day Of Month"
}
},
"required": false,
"type": "object",
"description": "Recur definition yearly by date.",
"title": "Recur Yearly by Date"
},
"recurWeekly": {
"properties": {
"monday": {
"type": "boolean",
"description": "Frequency of occurrence in weeks and select the day - Monday",
"title": "Monday"
},
"tuesday": {
"type": "boolean",
"description": "Frequency of occurrence in weeks and select the day - Tuesday",
"title": "Tuesday"
},
"friday": {
"type": "boolean",
"description": "Frequency of occurrence in weeks and select the day - Friday",
"title": "Friday"
},
"wednesday": {
"type": "boolean",
"description": "Frequency of occurrence in weeks and select the day - Wednesday",
"title": "Wednesday"
},
"thursday": {
"type": "boolean",
"description": "Frequency of occurrence in weeks and select the day - Thursday",
"title": "Thursday"
},
"sunday": {
"type": "boolean",
"description": "Frequency of occurrence in weeks and select the day - Sunday",
"title": "Sunday"
},
"saturday": {
"type": "boolean",
"description": "Frequency of occurrence in weeks and select the day - Saturday",
"title": "Saturday"
}
},
"required": false,
"type": "object",
"description": "Recurrence weekly definition.",
"title": "Recur Weekly"
}
},
"required": false,
"type": "object",
"description": "Recurrence definition.",
"title": "Recurrence"
},
"startTime": {
"type": "string",
"description": "Start time of event.",
"title": "Start Time"
},
"endTime": {
"type": "string",
"description": "End time of event.",
"title": "End Time"
},
"id": {
"type": "string",
"description": "Unique identifier for the event.",
"title": "ID"
}
}
},
"type": "array",
"description": "List of schedule events.",
"title": "Events"
},
"locationName": {
"type": "string",
"description": "The name of the location of the schedule.",
"title": "Webex Location Name"
},
"locationId": {
"type": "string",
"description": "A unique identifier for the location of the schedule.",
"title": "Location ID"
},
"schedules_id": {
"type": "string",
"description": "Generated new key field used to pass to get_by_value in driver.",
"title": "New Business Key"
},
"scheduleType": {
"choices": [
{
"value": "businessHours",
"title": "businessHours"
},
{
"value": "holidays",
"title": "holidays"
}
],
"type": "string",
"description": "A unique identifier for the schedule.",
"title": "Type"
},
"id": {
"type": "string",
"description": "A unique identifier for the schedule.",
"title": "ID"
}
},
"schema_version": "1.0.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/spark/Schedules/add/ |
|
The GUI Add form of device/spark/Schedules as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/device/spark/Schedules | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/spark/Schedules/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/spark/Schedules/[pkid1]", "/api/device/spark/Schedules/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/spark/Schedules/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/spark/Schedules/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/spark/Schedules/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/spark/Schedules/[pkid1]", "/api/v0/device/spark/Schedules/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/spark/Schedules/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/spark/Schedules |
|
{"hrefs": ["/api/device/spark/Schedules/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/spark/Schedules |
|
{"hrefs": ["/api/device/spark/Schedules/[pkid1]", "/api/device/spark/Schedules/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/spark/Schedules; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/spark/Schedules/export/ |
|
{ "hrefs":["/api/device/spark/Schedules/[pkid1]", "/api/device/spark/Schedules/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/spark/Schedules and the JSON format can be used to import instances of device/spark/Schedules.
GET http://[host-proxy]/api/device/spark/Schedules/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/spark/Schedules | POST | /api/device/spark/Schedules/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/spark/Schedules/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/spark/Schedules/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/device/spark/Schedules/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/spark/Schedules/ |
|
The device/spark/Schedules schema and all instances as JSON. |
(The list will return 0 to 3 device/spark/Schedules instances)
{
"operations": [
"list"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/spark/Schedules/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 10
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "1.0.0",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/device/spark/Schedules/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/spark/Schedules/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/spark/Schedules/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/spark/Schedules",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/Schedules/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/spark/Schedules/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Schedules/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Schedules/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/spark/Schedules/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/spark/Schedules/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/device/spark/Schedules/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/spark/Schedules/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/spark/Schedules/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/Schedules/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/device/spark/Schedules/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "device/spark/Schedules",
"model_specific_actions": [
"list",
"get",
"update",
"remove",
"move",
"export",
"export_bulkload_template",
"bulk_update_form",
"configuration_template",
"field_display_policy",
"help",
"migration",
"transform",
"tag",
"tag_version",
"import",
"add"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "scheduleType",
"title": "Type"
},
{
"name": "locationName",
"title": "Webex Location Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "65e0a1b56fd4534903e4fa58",
"meta": {
"tags": [],
"cached": true,
"title": "Holidays-UK",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"self": [
{
"pkid": "65e0a1b56fd4534903e4fa58",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e0a1b56fd4534903e4fa58/?model_type=device/spark/Schedules",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/import/",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/spark/Schedules",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e0a1b56fd4534903e4fa58"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "scheduleType",
"title": "Type"
},
{
"name": "locationName",
"title": "Webex Location Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"name": "Holidays-UK",
"hierarchy": "6130d69ae04a4a0015a93bc6",
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1NHOXNhV1JoZVhNdFZVcz0",
"locationName": "VOSS-GBR-Bournemouth",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzU3OWEyYjEyLTg1NzAtNDc0ZS1hMWI5LTY3OGNmOTYyZGNhZQ",
"summary_device": "Connection parameters for Spark Customer AAAGlobal, AAAGlobal, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"scheduleType": "holidays",
"schedules_id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1NHOXNhV1JoZVhNdFZVcz0:Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzU3OWEyYjEyLTg1NzAtNDc0ZS1hMWI5LTY3OGNmOTYyZGNhZQ:VOSS-GBR-Bournemouth:Holidays-UK:holidays",
"events": [
{
"startDate": "2023-12-26",
"endDate": "2023-12-26",
"name": "BoxingDay",
"allDayEnabled": true,
"recurrence": {
"recurForEver": true,
"recurYearlyByDate": {
"month": "DECEMBER",
"dayOfMonth": 26
}
},
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1FtOTRhVzVuUkdGNQ"
},
{
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"name": "Christmas",
"allDayEnabled": true,
"recurrence": {
"recurForEver": true,
"recurYearlyByDate": {
"month": "DECEMBER",
"dayOfMonth": 25
}
},
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1EyaHlhWE4wYldGeg"
},
{
"startDate": "2023-12-31",
"endDate": "2023-12-31",
"name": "NewYearsEve",
"allDayEnabled": true,
"recurrence": {
"recurForEver": true,
"recurYearlyByDate": {
"month": "DECEMBER",
"dayOfMonth": 31
}
},
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1RtVjNXV1ZoY25ORmRtVT0"
}
],
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "65e0a1b06fd4534903e4fa26",
"meta": {
"tags": [],
"cached": true,
"title": "Holidays-US",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"self": [
{
"pkid": "65e0a1b06fd4534903e4fa26",
"href": "/api/device/spark/Schedules/65e0a1b06fd4534903e4fa26/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/spark/Schedules/65e0a1b06fd4534903e4fa26/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/spark/Schedules/65e0a1b06fd4534903e4fa26/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e0a1b06fd4534903e4fa26/?model_type=device/spark/Schedules",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"import": {
"support_async": true,
"href": "/api/device/spark/Schedules/65e0a1b06fd4534903e4fa26/import/",
"title": "Import",
"method": "POST",
"class": "import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/Schedules/65e0a1b06fd4534903e4fa26/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/spark/Schedules/65e0a1b06fd4534903e4fa26/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/spark/Schedules/65e0a1b06fd4534903e4fa26/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/spark/Schedules/65e0a1b06fd4534903e4fa26/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/spark/Schedules/65e0a1b06fd4534903e4fa26/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/spark/Schedules/65e0a1b06fd4534903e4fa26/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/spark/Schedules",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e0a1b06fd4534903e4fa26"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "scheduleType",
"title": "Type"
},
{
"name": "locationName",
"title": "Webex Location Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"name": "Holidays-US",
"hierarchy": "6130d69ae04a4a0015a93bc6",
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1NHOXNhV1JoZVhNdFZWTT0",
"locationName": "VOSS-USA-SanJose",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzE2OWFkNWJjLTNkMWYtNGEwOS04NDRiLTJkOTllYjE1MDIwNQ",
"summary_device": "Connection parameters for Spark Customer AAAGlobal, AAAGlobal, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"scheduleType": "holidays",
"schedules_id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1NHOXNhV1JoZVhNdFZWTT0:Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzE2OWFkNWJjLTNkMWYtNGEwOS04NDRiLTJkOTllYjE1MDIwNQ:VOSS-USA-SanJose:Holidays-US:holidays",
"events": [
{
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"name": "Christmastime",
"allDayEnabled": true,
"recurrence": {
"recurForEver": true,
"recurYearlyByDate": {
"month": "DECEMBER",
"dayOfMonth": 25
}
},
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1EyaHlhWE4wYldGemRHbHRaUT09"
}
],
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "65e0a1b26fd4534903e4fa3a",
"meta": {
"tags": [],
"cached": true,
"title": "Ringwood-Sched",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"self": [
{
"pkid": "65e0a1b26fd4534903e4fa3a",
"href": "/api/device/spark/Schedules/65e0a1b26fd4534903e4fa3a/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/spark/Schedules/65e0a1b26fd4534903e4fa3a/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/device/spark/Schedules/65e0a1b26fd4534903e4fa3a/",
"class": "delete",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/65e0a1b26fd4534903e4fa3a/?model_type=device/spark/Schedules",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"import": {
"support_async": true,
"class": "import",
"href": "/api/device/spark/Schedules/65e0a1b26fd4534903e4fa3a/import/",
"method": "POST",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/spark/Schedules/65e0a1b26fd4534903e4fa3a/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/spark/Schedules/65e0a1b26fd4534903e4fa3a/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/spark/Schedules/65e0a1b26fd4534903e4fa3a/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/spark/Schedules/65e0a1b26fd4534903e4fa3a/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/spark/Schedules/65e0a1b26fd4534903e4fa3a/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/spark/Schedules/65e0a1b26fd4534903e4fa3a/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/spark/Schedules",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e0a1b26fd4534903e4fa3a"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "scheduleType",
"title": "Type"
},
{
"name": "locationName",
"title": "Webex Location Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"name": "Ringwood-Sched",
"hierarchy": "6130d69ae04a4a0015a93bc6",
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1VtbHVaM2R2YjJRdFUyTm9aV1E9",
"locationName": "VOSS-GBR-Ringwood",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzM2MGJmZDIxLTMxNDItNDA3MS05ZTU0LWUyZGY2MmNlNzc3Zg",
"summary_device": "Connection parameters for Spark Customer AAAGlobal, AAAGlobal, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"scheduleType": "businessHours",
"schedules_id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1VtbHVaM2R2YjJRdFUyTm9aV1E9:Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzM2MGJmZDIxLTMxNDItNDA3MS05ZTU0LWUyZGY2MmNlNzc3Zg:VOSS-GBR-Ringwood:Ringwood-Sched:businessHours",
"events": [
{
"startDate": "2023-09-08",
"endDate": "2023-09-08",
"name": "Friday 1",
"allDayEnabled": false,
"recurrence": {
"recurForEver": true,
"recurWeekly": {
"monday": false,
"tuesday": false,
"friday": true,
"wednesday": false,
"thursday": false,
"sunday": false,
"saturday": false
}
},
"startTime": "09:00",
"endTime": "12:00",
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1JuSnBaR0Y1SURFPQ"
},
{
"startDate": "2023-09-08",
"endDate": "2023-09-08",
"name": "Friday 2",
"allDayEnabled": false,
"recurrence": {
"recurForEver": true,
"recurWeekly": {
"monday": false,
"tuesday": false,
"friday": true,
"wednesday": false,
"thursday": false,
"sunday": false,
"saturday": false
}
},
"startTime": "13:00",
"endTime": "17:00",
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1JuSnBaR0Y1SURJPQ"
},
{
"startDate": "2023-09-11",
"endDate": "2023-09-11",
"name": "Monday 1",
"allDayEnabled": false,
"recurrence": {
"recurForEver": true,
"recurWeekly": {
"monday": true,
"tuesday": false,
"friday": false,
"wednesday": false,
"thursday": false,
"sunday": false,
"saturday": false
}
},
"startTime": "09:00",
"endTime": "12:00",
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1RXOXVaR0Y1SURFPQ"
},
{
"startDate": "2023-09-11",
"endDate": "2023-09-11",
"name": "Monday 2",
"allDayEnabled": false,
"recurrence": {
"recurForEver": true,
"recurWeekly": {
"monday": true,
"tuesday": false,
"friday": false,
"wednesday": false,
"thursday": false,
"sunday": false,
"saturday": false
}
},
"startTime": "13:00",
"endTime": "17:00",
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1RXOXVaR0Y1SURJPQ"
},
{
"startDate": "2023-09-07",
"endDate": "2023-09-07",
"name": "Thursday 1",
"allDayEnabled": false,
"recurrence": {
"recurForEver": true,
"recurWeekly": {
"monday": false,
"tuesday": false,
"friday": false,
"wednesday": false,
"thursday": true,
"sunday": false,
"saturday": false
}
},
"startTime": "09:00",
"endTime": "12:00",
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1ZHaDFjbk5rWVhrZ01RPT0"
},
{
"startDate": "2023-09-07",
"endDate": "2023-09-07",
"name": "Thursday 2",
"allDayEnabled": false,
"recurrence": {
"recurForEver": true,
"recurWeekly": {
"monday": false,
"tuesday": false,
"friday": false,
"wednesday": false,
"thursday": true,
"sunday": false,
"saturday": false
}
},
"startTime": "13:00",
"endTime": "17:00",
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1ZHaDFjbk5rWVhrZ01nPT0"
},
{
"startDate": "2023-09-12",
"endDate": "2023-09-12",
"name": "Tuesday 1",
"allDayEnabled": false,
"recurrence": {
"recurForEver": true,
"recurWeekly": {
"monday": false,
"tuesday": true,
"friday": false,
"wednesday": false,
"thursday": false,
"sunday": false,
"saturday": false
}
},
"startTime": "09:00",
"endTime": "12:00",
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1ZIVmxjMlJoZVNBeA"
},
{
"startDate": "2023-09-12",
"endDate": "2023-09-12",
"name": "Tuesday 2",
"allDayEnabled": false,
"recurrence": {
"recurForEver": true,
"recurWeekly": {
"monday": false,
"tuesday": true,
"friday": false,
"wednesday": false,
"thursday": false,
"sunday": false,
"saturday": false
}
},
"startTime": "13:00",
"endTime": "17:00",
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1ZIVmxjMlJoZVNBeQ"
},
{
"startDate": "2023-09-13",
"endDate": "2023-09-13",
"name": "Wednesday 1",
"allDayEnabled": false,
"recurrence": {
"recurForEver": true,
"recurWeekly": {
"monday": false,
"tuesday": false,
"friday": false,
"wednesday": true,
"thursday": false,
"sunday": false,
"saturday": false
}
},
"startTime": "09:00",
"endTime": "12:00",
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1YyVmtibVZ6WkdGNUlERT0"
},
{
"startDate": "2023-09-13",
"endDate": "2023-09-13",
"name": "Wednesday 2",
"allDayEnabled": false,
"recurrence": {
"recurForEver": true,
"recurWeekly": {
"monday": false,
"tuesday": false,
"friday": false,
"wednesday": true,
"thursday": false,
"sunday": false,
"saturday": false
}
},
"startTime": "13:00",
"endTime": "17:00",
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1YyVmtibVZ6WkdGNUlEST0"
}
],
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "65e0a1b56fd4534903e4fa58",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Holidays-UK",
"business_key": {},
"schema_version": "",
"references": {
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"self": [
{
"pkid": "65e0a1b56fd4534903e4fa58",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e0a1b56fd4534903e4fa58/?hierarchy=[hierarchy]&model_type=device/spark/Schedules",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/import/?hierarchy=[hierarchy]",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/Schedules/65e0a1b56fd4534903e4fa58/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/spark/Schedules",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e0a1b56fd4534903e4fa58"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "scheduleType",
"title": "Type"
},
{
"name": "locationName",
"title": "Webex Location Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"name": "Holidays-UK",
"hierarchy": "6130d69ae04a4a0015a93bc6",
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1NHOXNhV1JoZVhNdFZVcz0",
"locationName": "VOSS-GBR-Bournemouth",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzU3OWEyYjEyLTg1NzAtNDc0ZS1hMWI5LTY3OGNmOTYyZGNhZQ",
"schedules_id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1NHOXNhV1JoZVhNdFZVcz0:Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzU3OWEyYjEyLTg1NzAtNDc0ZS1hMWI5LTY3OGNmOTYyZGNhZQ:VOSS-GBR-Bournemouth:Holidays-UK:holidays",
"scheduleType": "holidays",
"events": [
{
"startDate": "2023-12-26",
"endDate": "2023-12-26",
"name": "BoxingDay",
"allDayEnabled": true,
"recurrence": {
"recurForEver": true,
"recurYearlyByDate": {
"month": "DECEMBER",
"dayOfMonth": 26
}
},
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1FtOTRhVzVuUkdGNQ"
},
{
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"name": "Christmas",
"allDayEnabled": true,
"recurrence": {
"recurForEver": true,
"recurYearlyByDate": {
"month": "DECEMBER",
"dayOfMonth": 25
}
},
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1EyaHlhWE4wYldGeg"
},
{
"startDate": "2023-12-31",
"endDate": "2023-12-31",
"name": "NewYearsEve",
"allDayEnabled": true,
"recurrence": {
"recurForEver": true,
"recurYearlyByDate": {
"month": "DECEMBER",
"dayOfMonth": 31
}
},
"id": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1RtVjNXV1ZoY25ORmRtVT0"
}
]
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/spark/Schedules. | GET | /api/device/spark/Schedules/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/spark/Schedules as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/spark/Schedules/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/spark/Schedules/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/spark/Schedules | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/device/spark/Schedules/[pkid]/import | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/spark/Schedules; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/spark/Schedules/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/spark/Schedules and the JSON format can be used to import instances of device/spark/Schedules.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/spark/Schedules/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/spark/Schedules/[pkid] | hierarchy=[hierarchy] | The device/spark/Schedules instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/spark/Schedules/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/spark/Schedules. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/spark/Schedules/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |