[Index]
Model ref.: device/cuc/Schedule
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": { "StartDate": { "minItems": 0, "type": "string", "description": " The date and time when schedule becomes active, or NULL if active immediately.", "name": "StartDate", "title": "Start Date" }, "DisplayName": { "minItems": 0, "type": "string", "description": " The preferred text name of this schedule to be used when displaying entries in the administrative console and Cisco Personal Assistant.", "name": "DisplayName", "title": "Display Name" }, "OwnerUserURI": { "name": "OwnerUserURI", "format": "uri", "minItems": 0, "title": "Owner User URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "ObjectId": { "description": " The primary key for this table. A globally unique, system-generated identifier for a Schedule object. - template parameter [1]", "title": "Object Id", "minItems": 0, "readonly": true, "type": "string", "name": "ObjectId" }, "OwnerLocationObjectId": { "minItems": 0, "type": "string", "description": " The owner of this schedule. If the owner is a LocationVMS, the unique identifier of the LocationVMS object to which this schedule belongs. Commonly referred to as a \"system\" schedule. Otherwise, this attribute is set to NULL.", "name": "OwnerLocationObjectId", "title": "Owner Location Object Id" }, "URI": { "name": "URI", "format": "uri", "minItems": 0, "title": "URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "OwnerLocationURI": { "name": "OwnerLocationURI", "format": "uri", "minItems": 0, "title": "Owner Location URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "IsHoliday": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether this schedule represents a holiday.", "name": "IsHoliday", "title": "Is Holiday" }, "ScheduleDetailsURI": { "name": "ScheduleDetailsURI", "format": "uri", "minItems": 0, "title": "Schedule Details URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "OwnerSubscriberObjectId": { "minItems": 0, "type": "string", "description": " The owner of this schedule. If the owner is a subscriber, the unique identifier of the Subscriber object to which this schedule belongs. Otherwise, this attribute is set to NULL.", "name": "OwnerSubscriberObjectId", "title": "Owner Subscriber Object Id" }, "OwnerPersonalRuleSetObjectId": { "minItems": 0, "type": "string", "description": " The owner of this schedule. If the owner is a personal rule set, the unique identifier of the PersonalRuleSet to which this schedule belongs. Otherwise, this attribute is set to NULL.", "name": "OwnerPersonalRuleSetObjectId", "title": "Owner Personal Rule Set Object Id" }, "TenantObjectId": { "minItems": 0, "type": "string", "description": " Unique ObjectId of the tbl_Tenant", "name": "TenantObjectId", "title": "Tenant Object Id" }, "EndDate": { "minItems": 0, "type": "string", "description": " The date and time when schedule ends, or NULL if effective indefinitely.", "name": "EndDate", "title": "End Date" }, "Undeletable": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether this schedule can be deleted via an administrative application such as Cisco Unity Connection Administration. It is used to prevent deletion of factory defaults.", "name": "Undeletable", "title": "Undeletable" } }, "schema_version": "12.5" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/cuc/Schedule/add/ |
|
The GUI Add form of device/cuc/Schedule 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/cuc/Schedule/ | 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/cuc/Schedule/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/Schedule/[pkid1]", "/api/device/cuc/Schedule/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/Schedule/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cuc/Schedule/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cuc/Schedule/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/Schedule/[pkid1]", "/api/v0/device/cuc/Schedule/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/Schedule/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cuc/Schedule |
|
{"hrefs": ["/api/device/cuc/Schedule/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/Schedule |
|
{"hrefs": ["/api/device/cuc/Schedule/[pkid1]", "/api/device/cuc/Schedule/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/Schedule; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/Schedule/export/ |
|
{ "hrefs":["/api/device/cuc/Schedule/[pkid1]", "/api/device/cuc/Schedule/[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/cuc/Schedule and the JSON format can be used to import instances of device/cuc/Schedule.
GET http://[host-proxy]/api/device/cuc/Schedule/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/Schedule | POST | /api/device/cuc/Schedule/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/cuc/Schedule/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/cuc/Schedule/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cuc/Schedule/ |
|
The device/cuc/Schedule schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/Schedule instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cuc/Schedule/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 39 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "12.5", "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/cuc/Schedule/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/Schedule/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cuc/Schedule/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/cuc/Schedule", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/Schedule/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/cuc/Schedule/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cuc/Schedule/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cuc/Schedule/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cuc/Schedule/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/Schedule/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/Schedule/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/Schedule", "model_specific_actions": [ "add", "list", "update", "get", "remove", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display Name" }, { "name": "StartDate", "title": "Start Date" }, { "name": "EndDate", "title": "End Date" }, { "name": "Undeletable", "title": "Undeletable" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "19.3.1", "tagged_versions": [] }, "resources": [ { "pkid": "5dcd35d68192d40018f79112", "meta": { "tags": [], "cached": true, "title": "2019Holidays", "business_key": {}, "schema_version": "", "summary": "false", "references": { "device": [ { "pkid": "5dcd18514544b7001860529a", "href": "/api/v0/data/UnityConnection/5dcd18514544b7001860529a" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5dcd35d68192d40018f79112", "href": "/api/device/cuc/Schedule/5dcd35d68192d40018f79112/" } ], "parent": [ { "pkid": "5dcd194fe186e30018eb7c58", "href": "/api/data/HierarchyNode/5dcd194fe186e30018eb7c58" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cuc/Schedule/5dcd35d68192d40018f79112/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/Schedule/5dcd35d68192d40018f79112/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/Schedule/5dcd35d68192d40018f79112/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5dcd35d68192d40018f79112/?model_type=device/cuc/Schedule", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/Schedule/5dcd35d68192d40018f79112/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/Schedule/5dcd35d68192d40018f79112/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/Schedule/5dcd35d68192d40018f79112/help", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/Schedule/5dcd35d68192d40018f79112/purge/", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/Schedule", "path": [ "6t0ggef2c0deab00hb595101", "5dcc7ff74544b7001862482f", "5dcd17c256b5de00189138f9", "5dcd180233fc9b00189005b2", "5dcd1812e186e30018eb7023", "5dcd194fe186e30018eb7c58", "5dcd35d68192d40018f79112" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display Name" }, { "name": "StartDate", "title": "Start Date" }, { "name": "EndDate", "title": "End Date" }, { "name": "Undeletable", "title": "Undeletable" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "19.3.1", "tagged_versions": [] }, "data": { "DisplayName": "2019Holidays", "ObjectId": "139cee87-46ec-4f8b-827a-1155d8e40f9d", "OwnerLocationObjectId": "e21cf6d2-ae77-4cf0-bb98-f94b8550c291", "URI": "/vmrest/schedules/139cee87-46ec-4f8b-827a-1155d8e40f9d", "OwnerLocationURI": "/vmrest/locations/connectionlocations/e21cf6d2-ae77-4cf0-bb98-f94b8550c291", "IsHoliday": true, "ScheduleDetailsURI": "/vmrest/schedules/139cee87-46ec-4f8b-827a-1155d8e40f9d/scheduledetails", "hierarchy_friendly_name": "LOC001 (Site)", "summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal", "Undeletable": false, "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal.LOC001" } }, { "pkid": "5dcd30ec8192d40018f77ea1", "meta": { "tags": [], "cached": true, "title": "All Hours", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5dcd3073e186e30018ebc837", "href": "/api/v0/data/UnityConnection/5dcd3073e186e30018ebc837" } ], "self": [ { "pkid": "5dcd30ec8192d40018f77ea1", "href": "/api/device/cuc/Schedule/5dcd30ec8192d40018f77ea1/" } ], "parent": [ { "pkid": "5dcd2d8b9d77dd0018b0ebe6", "href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/device/cuc/Schedule/5dcd30ec8192d40018f77ea1/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/device/cuc/Schedule/5dcd30ec8192d40018f77ea1/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "clone": { "support_async": false, "href": "/api/device/cuc/Schedule/5dcd30ec8192d40018f77ea1/clone/?schema=&schema_rules=true", "title": "Clone", "class": "clone", "method": "GET" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5dcd30ec8192d40018f77ea1/?model_type=device/cuc/Schedule", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/Schedule/5dcd30ec8192d40018f77ea1/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "href": "/api/device/cuc/Schedule/5dcd30ec8192d40018f77ea1/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/device/cuc/Schedule/5dcd30ec8192d40018f77ea1/help", "title": "Help", "class": "help", "method": "GET" } }, { "purge": { "support_async": false, "href": "/api/device/cuc/Schedule/5dcd30ec8192d40018f77ea1/purge/", "title": "Purge", "class": "purge", "method": "POST" } } ], "model_type": "device/cuc/Schedule", "path": [ "6t0ggef2c0deab00hb595101", "5dcc7ff74544b7001862482f", "5dcd17c256b5de00189138f9", "5dcd180233fc9b00189005b2", "5dcd2d8b9d77dd0018b0ebe6", "5dcd30ec8192d40018f77ea1" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display Name" }, { "name": "StartDate", "title": "Start Date" }, { "name": "EndDate", "title": "End Date" }, { "name": "Undeletable", "title": "Undeletable" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "19.3.1", "tagged_versions": [] }, "data": { "DisplayName": "All Hours", "ObjectId": "5399cfd9-1f4c-4550-b94e-35749522ac53", "hierarchy": "5dcd2d8b9d77dd0018b0ebe6", "OwnerLocationObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa", "URI": "/vmrest/schedules/5399cfd9-1f4c-4550-b94e-35749522ac53", "OwnerLocationURI": "/vmrest/locations/connectionlocations/cee60b09-5a48-46fc-9fb7-2923257dcffa", "IsHoliday": false, "ScheduleDetailsURI": "/vmrest/schedules/5399cfd9-1f4c-4550-b94e-35749522ac53/scheduledetails", "hierarchy_friendly_name": "Overton (Customer)", "summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton", "Undeletable": true, "hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton" } }, { "pkid": "5dcd189a56b5de0018914c32", "meta": { "tags": [], "cached": true, "title": "All Hours", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5dcd18514544b7001860529a", "href": "/api/v0/data/UnityConnection/5dcd18514544b7001860529a" } ], "self": [ { "pkid": "5dcd189a56b5de0018914c32", "href": "/api/device/cuc/Schedule/5dcd189a56b5de0018914c32/" } ], "parent": [ { "pkid": "5dcd1812e186e30018eb7023", "href": "/api/data/HierarchyNode/5dcd1812e186e30018eb7023" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/device/cuc/Schedule/5dcd189a56b5de0018914c32/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/device/cuc/Schedule/5dcd189a56b5de0018914c32/", "class": "delete", "title": "Delete" } }, { "clone": { "support_async": false, "method": "GET", "href": "/api/device/cuc/Schedule/5dcd189a56b5de0018914c32/clone/?schema=&schema_rules=true", "class": "clone", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5dcd189a56b5de0018914c32/?model_type=device/cuc/Schedule", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/Schedule/5dcd189a56b5de0018914c32/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/device/cuc/Schedule/5dcd189a56b5de0018914c32/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/device/cuc/Schedule/5dcd189a56b5de0018914c32/help", "class": "help", "title": "Help" } }, { "purge": { "support_async": false, "method": "POST", "href": "/api/device/cuc/Schedule/5dcd189a56b5de0018914c32/purge/", "class": "purge", "title": "Purge" } } ], "model_type": "device/cuc/Schedule", "path": [ "6t0ggef2c0deab00hb595101", "5dcc7ff74544b7001862482f", "5dcd17c256b5de00189138f9", "5dcd180233fc9b00189005b2", "5dcd1812e186e30018eb7023", "5dcd189a56b5de0018914c32" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display Name" }, { "name": "StartDate", "title": "Start Date" }, { "name": "EndDate", "title": "End Date" }, { "name": "Undeletable", "title": "Undeletable" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "19.3.1", "tagged_versions": [] }, "data": { "DisplayName": "All Hours", "ObjectId": "2007b5aa-e135-4938-bed3-fae2d279b991", "hierarchy": "5dcd1812e186e30018eb7023", "OwnerLocationObjectId": "e21cf6d2-ae77-4cf0-bb98-f94b8550c291", "URI": "/vmrest/schedules/2007b5aa-e135-4938-bed3-fae2d279b991", "OwnerLocationURI": "/vmrest/locations/connectionlocations/e21cf6d2-ae77-4cf0-bb98-f94b8550c291", "IsHoliday": false, "ScheduleDetailsURI": "/vmrest/schedules/2007b5aa-e135-4938-bed3-fae2d279b991/scheduledetails", "hierarchy_friendly_name": "AAAGlobal (Customer)", "summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal", "Undeletable": true, "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal" } } ] }
(Show the first instance)
{ "pkid": "5dcd35d68192d40018f79112", "meta": { "tags": [], "cached": true, "cache_control_policy": "cache_then_device", "title": "2019Holidays", "business_key": {}, "schema_version": "12.5", "references": { "parent": [ { "pkid": "5dcd194fe186e30018eb7c58", "href": "/api/data/HierarchyNode/5dcd194fe186e30018eb7c58" } ], "self": [ { "pkid": "5dcd35d68192d40018f79112", "href": "/api/device/cuc/Schedule/5dcd35d68192d40018f79112/" } ], "foreign_key": [], "device": [ { "pkid": "5dcd18514544b7001860529a", "href": "/api/v0/data/UnityConnection/5dcd18514544b7001860529a" } ], "owner": [ { "pkid": "" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cuc/Schedule/5dcd35d68192d40018f79112/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/Schedule/5dcd35d68192d40018f79112/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/Schedule/5dcd35d68192d40018f79112/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5dcd35d68192d40018f79112/?hierarchy=[hierarchy]&model_type=device/cuc/Schedule", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/Schedule/5dcd35d68192d40018f79112/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/Schedule/5dcd35d68192d40018f79112/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/Schedule/5dcd35d68192d40018f79112/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/Schedule/5dcd35d68192d40018f79112/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/Schedule", "path": [ "6t0ggef2c0deab00hb595101", "5dcc7ff74544b7001862482f", "5dcd17c256b5de00189138f9", "5dcd180233fc9b00189005b2", "5dcd1812e186e30018eb7023", "5dcd194fe186e30018eb7c58", "5dcd35d68192d40018f79112" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display Name" }, { "name": "StartDate", "title": "Start Date" }, { "name": "EndDate", "title": "End Date" }, { "name": "Undeletable", "title": "Undeletable" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "19.3.1", "tagged_versions": [] }, "data": { "DisplayName": "2019Holidays", "ObjectId": "139cee87-46ec-4f8b-827a-1155d8e40f9d", "OwnerLocationObjectId": "e21cf6d2-ae77-4cf0-bb98-f94b8550c291", "URI": "/vmrest/schedules/139cee87-46ec-4f8b-827a-1155d8e40f9d", "OwnerLocationURI": "/vmrest/locations/connectionlocations/e21cf6d2-ae77-4cf0-bb98-f94b8550c291", "IsHoliday": true, "ScheduleDetailsURI": "/vmrest/schedules/139cee87-46ec-4f8b-827a-1155d8e40f9d/scheduledetails", "Undeletable": false } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/cuc/Schedule. | GET | /api/device/cuc/Schedule/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/Schedule as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/cuc/Schedule/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/cuc/Schedule/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/Schedule/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/Schedule/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/Schedule | 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/cuc/Schedule; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/Schedule/[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/cuc/Schedule and the JSON format can be used to import instances of device/cuc/Schedule.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cuc/Schedule/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/Schedule instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cuc/Schedule/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/Schedule. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cuc/Schedule/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |