[Index]
Model ref.: relation/CucScheduleREL
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" }, "Set": { "type": "object", "properties": { "DisplayName": { "minItems": 0, "type": "string", "description": " The unique text name of this schedule set to be used when displaying entries in the administrative console and Cisco Personal Assistant.", "name": "DisplayName", "title": "Display Name" }, "OwnerSubscriberObjectId": { "minItems": 0, "type": "string", "description": " The owner of this schedule set. If the owner is a subscriber, the unique identifier of the Subscriber object to which this schedule set belongs. Otherwise, this attribute is set to NULL.", "name": "OwnerSubscriberObjectId", "title": "Owner Subscriber Object Id" }, "ObjectId": { "description": " The primary key for this table. A globally unique, system-generated identifier for a ScheduleSet object. - template parameter [1]", "title": "Object Id", "minItems": 0, "readonly": true, "type": "string", "name": "ObjectId" }, "OwnerLocationObjectId": { "target_title": "DisplayName", "description": " The owner of this schedule set. If the owner is a LocationVMS, the unique identifier of the LocationVMS object to which this schedule set (i.e., \"system\" schedule) belongs. Otherwise, this attribute is set to NULL.", "title": "Schedule", "minItems": 0, "format": "uri", "choices": [], "target_attr": "ObjectId", "target": "/api/device/cuc/Schedule/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_model_type": "device/cuc/Schedule", "type": "string", "name": "OwnerLocationObjectId" }, "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] }, "ScheduleSetMembersURI": { "name": "ScheduleSetMembersURI", "format": "uri", "minItems": 0, "title": "Schedule Set Members URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "OwnerUserURI": { "name": "OwnerUserURI", "format": "uri", "minItems": 0, "title": "Owner User URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "OwnerPersonalRuleSetObjectId": { "minItems": 0, "type": "string", "description": " The owner of this schedule set. If the owner is a personal rule set, the unique identifier of the PersonalRuleSet to which this schedule set belongs. Otherwise, this attribute is set to NULL.", "name": "OwnerPersonalRuleSetObjectId", "title": "Owner Personal Rule Set Object Id" }, "Undeletable": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether this schedule set 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" } }, "title": "Set" }, "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" }, "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" }, "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" }, "Detail": { "items": { "type": "object", "properties": { "StartDate": { "minItems": 0, "type": "string", "description": " The date when this schedule detail becomes active. A value of NULL means the schedule is active immediately.", "name": "StartDate", "title": "Start Date" }, "IsActiveSaturday": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether this schedule is active on Saturday.", "name": "IsActiveSaturday", "title": "Is Active Saturday" }, "IsActiveThursday": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether this schedule is active on this Thursday.", "name": "IsActiveThursday", "title": "Is Active Thursday" }, "ScheduleObjectId": { "target_title": "DisplayName", "description": " The unique identifier of the parent Schedule object to which this schedule detail row belongs. - template parameter [1]", "format": "uri", "minItems": 0, "title": "Schedule", "required": true, "choices": [], "target_attr": "ObjectId", "target": "/api/device/cuc/Schedule/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_model_type": "device/cuc/Schedule", "type": "string", "name": "ScheduleObjectId" }, "ObjectId": { "description": " The primary key for this table. A globally unique, system-generated identifier for a ScehduelDetail object. - template parameter [2]", "title": "Object Id", "minItems": 0, "readonly": true, "type": "string", "name": "ObjectId" }, "IsActiveMonday": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether this schedule is active on Monday.", "name": "IsActiveMonday", "title": "Is Active Monday" }, "IsActiveWednesday": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether this schedule is active on Wednesday.", "name": "IsActiveWednesday", "title": "Is Active Wednesday" }, "ScheduleURI": { "name": "ScheduleURI", "format": "uri", "minItems": 0, "title": "Schedule URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "URI": { "name": "URI", "format": "uri", "minItems": 0, "title": "URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "EndOfDay": { "type": "boolean", "description": "Check this check box to specify that the schedule becomes inactive at midnight (the end of the day). \n", "name": "EndOfDay", "title": "End Of Day" }, "StartTime": { "minItems": 0, "type": "integer", "description": " The start time (in minutes) for the active day or days. The start time is stored as the number of minutes from midnight. So a value of 480 would mean 8:00 AM and 1020 would mean 5:00 PM. In addition, a value of NULL for the start time indicates 12:00 AM.", "name": "StartTime", "title": "Start Time" }, "IsActiveTuesday": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether this schedule is active on Tuesday.", "name": "IsActiveTuesday", "title": "Is Active Tuesday" }, "IsActiveFriday": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether this schedule is active on Friday.", "name": "IsActiveFriday", "title": "Is Active Friday" }, "IsActiveSunday": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether this schedule is active on Sunday.", "name": "IsActiveSunday", "title": "Is Active Sunday" }, "EndDate": { "minItems": 0, "type": "string", "description": " The date when this schedule detail ends. A value of NULL indicates the scheule is active indefinitely.", "name": "EndDate", "title": "End Date" }, "EndTime": { "minItems": 0, "type": "integer", "description": " The end time (in minutes) for the active day or days. The end time is stored as the number of minutes from midnight. So a value of 480 would mean 8:00 AM and 1020 would mean 5:00 PM. In addition, a value of NULL means \"till the end of the day\" (e.g. 11:59:59 PM in Linux land).", "name": "EndTime", "title": "End Time" }, "Subject": { "minItems": 0, "type": "string", "description": " The subject matter or description for this schedule detail row. ", "name": "Subject", "title": "Subject" } } }, "type": "array", "title": "Detail" }, "OwnerLocationURI": { "name": "OwnerLocationURI", "format": "uri", "minItems": 0, "title": "Owner Location URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "URI": { "name": "URI", "format": "uri", "minItems": 0, "title": "URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "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" }, "IsHoliday": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether this schedule represents a holiday.", "name": "IsHoliday", "title": "Is Holiday" }, "HF": { "type": "object", "properties": { "holiday_schedule": { "type": "string", "description": "Helper field for dropdown of available Holiday schedules for user to select from", "title": "Uses Holiday Schedule" }, "hierarchy_type": { "type": "string", "description": "Hidden (internal-only) helper field to store hierarchy node type (e.g. 'Site' or 'Customer')", "title": "Hierarchy Type" }, "cuc_info": { "type": "string", "description": "Informative (non-input) field. Indicates the target CUCx host/IP, which is automatically derived from the input NDL.", "title": "Cisco Unity Connection" }, "target_ndl": { "type": "string", "description": "Mandatory input-field for the Add use-case (if hierarchy is at Site-node, however, this value is derived automatically). The workflow (and GUIRules) will target the UC devices that is linked to this Network Device List (NDL). In the Mod use-case, this should also be derived automatically and can thus be omitted from Updates.", "title": "Network Device List" } }, "title": "Hf" } }, "schema_version": "1.1" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/relation/CucScheduleREL/add/ |
|
The GUI Add form of relation/CucScheduleREL 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/relation/CucScheduleREL | 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/relation/CucScheduleREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/CucScheduleREL/[pkid1]", "/api/relation/CucScheduleREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/CucScheduleREL/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/relation/CucScheduleREL/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/relation/CucScheduleREL/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/relation/CucScheduleREL/[pkid1]", "/api/v0/relation/CucScheduleREL/[pkid2]",...]}} |
GET http://[host-proxy]/api/relation/CucScheduleREL/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/CucScheduleREL |
|
{"hrefs": ["/api/relation/CucScheduleREL/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=relation/CucScheduleREL |
|
{"hrefs": ["/api/relation/CucScheduleREL/[pkid1]", "/api/relation/CucScheduleREL/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/CucScheduleREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/CucScheduleREL/export/ |
|
{ "hrefs":["/api/relation/CucScheduleREL/[pkid1]", "/api/relation/CucScheduleREL/[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 relation/CucScheduleREL and the JSON format can be used to import instances of relation/CucScheduleREL.
GET http://[host-proxy]/api/relation/CucScheduleREL/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for relation/CucScheduleREL | POST | /api/relation/CucScheduleREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/relation/CucScheduleREL/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/relation/CucScheduleREL/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Migration Template | GET | /api/relation/CucScheduleREL/migration/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/relation/CucScheduleREL/ |
|
The relation/CucScheduleREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/CucScheduleREL instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "move", "list", "update", "remove", "bulk_update", "add", "tag", "export", "migration", "bulk_update_form", "tag_version" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/relation/CucScheduleREL/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 18 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "1.1", "references": { "device": [ { "pkid": "", "href": "" } ], "self": [ { "pkid": null, "href": "/api/relation/CucScheduleREL/None/" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/relation/CucScheduleREL/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/relation/CucScheduleREL/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/relation/CucScheduleREL/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=relation/CucScheduleREL", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/relation/CucScheduleREL/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/relation/CucScheduleREL/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/relation/CucScheduleREL/+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/relation/CucScheduleREL/+tag_version/?hierarchy=[hierarchy]", "class": "tag_version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/relation/CucScheduleREL/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/relation/CucScheduleREL/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "migration": { "support_async": false, "class": "migration", "href": "/api/relation/CucScheduleREL/migration/?hierarchy=[hierarchy]", "method": "GET", "title": "Migration Template" } }, { "list": { "support_async": false, "class": "list", "href": "/api/relation/CucScheduleREL/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/relation/CucScheduleREL/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "relation/CucScheduleREL", "model_specific_actions": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "move", "list", "update", "remove", "add", "tag", "export", "migration", "bulk_update_form", "tag_version" ], "summary_attrs": [ { "name": "DisplayName", "title": "Schedule Display Name" }, { "name": "StartDate", "title": "Start Date" }, { "name": "EndDate", "title": "End Date" }, { "name": "Undeletable", "title": "System-Reserved" }, { "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": "5f3ae786ce894e001205a92f", "meta": { "tags": [], "cached": true, "title": "All Hours", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5f3ae59cce894e00120554b1", "href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1" } ], "self": [ { "pkid": "5f3ae786ce894e001205a92f", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/", "method": "DELETE", "title": "Delete" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3ae786ce894e001205a92f/?model_type=relation/CucScheduleREL", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/+tag/", "class": "tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "title": "Tag Version", "support_async": true, "method": "PATCH", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/+tag_version/", "class": "tag_version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/help", "method": "GET", "title": "Help" } }, { "AddDetail": { "title": "Add Detail", "support_async": true, "submit": "payload", "class": "add", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/+AddDetail/", "method": "POST", "schema": "Detail" } }, { "DelDetail": { "title": "Del Detail", "support_async": true, "submit": "payload", "class": "delete", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/+DelDetail/", "method": "POST", "schema": "Detail" } } ], "model_type": "relation/CucScheduleREL", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae786ce894e001205a92f" ], "summary_attrs": [ { "name": "DisplayName", "title": "Schedule Display Name" }, { "name": "StartDate", "title": "Start Date" }, { "name": "EndDate", "title": "End Date" }, { "name": "Undeletable", "title": "System-Reserved" }, { "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": { "DisplayName": "All Hours", "ObjectId": "768f15b6-92de-44bf-b3d7-fa7a924ddd96", "hierarchy": "5f3ae552ce894e00120537fa", "OwnerLocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2", "URI": "/vmrest/schedules/768f15b6-92de-44bf-b3d7-fa7a924ddd96", "OwnerLocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2", "IsHoliday": false, "ScheduleDetailsURI": "/vmrest/schedules/768f15b6-92de-44bf-b3d7-fa7a924ddd96/scheduledetails", "hierarchy_friendly_name": "AB_Group (Customer)", "summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group", "Undeletable": true, "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group" } }, { "pkid": "5f3ae78bce894e001205a9ea", "meta": { "tags": [], "cached": true, "title": "Holidays", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5f3ae59cce894e00120554b1", "href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1" } ], "self": [ { "pkid": "5f3ae78bce894e001205a9ea", "href": "/api/relation/CucScheduleREL/5f3ae78bce894e001205a9ea/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/relation/CucScheduleREL/5f3ae78bce894e001205a9ea/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/relation/CucScheduleREL/5f3ae78bce894e001205a9ea/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3ae78bce894e001205a9ea/?model_type=relation/CucScheduleREL", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/relation/CucScheduleREL/5f3ae78bce894e001205a9ea/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "class": "tag", "href": "/api/relation/CucScheduleREL/5f3ae78bce894e001205a9ea/+tag/", "method": "PATCH", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "title": "Tag Version", "support_async": true, "class": "tag_version", "href": "/api/relation/CucScheduleREL/5f3ae78bce894e001205a9ea/+tag_version/", "method": "PATCH", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "support_async": false, "href": "/api/relation/CucScheduleREL/5f3ae78bce894e001205a9ea/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/relation/CucScheduleREL/5f3ae78bce894e001205a9ea/help", "title": "Help", "class": "help", "method": "GET" } }, { "AddDetail": { "title": "Add Detail", "support_async": true, "submit": "payload", "class": "add", "href": "/api/relation/CucScheduleREL/5f3ae78bce894e001205a9ea/+AddDetail/", "method": "POST", "schema": "Detail" } }, { "DelDetail": { "title": "Del Detail", "support_async": true, "submit": "payload", "class": "delete", "href": "/api/relation/CucScheduleREL/5f3ae78bce894e001205a9ea/+DelDetail/", "method": "POST", "schema": "Detail" } } ], "model_type": "relation/CucScheduleREL", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae78bce894e001205a9ea" ], "summary_attrs": [ { "name": "DisplayName", "title": "Schedule Display Name" }, { "name": "StartDate", "title": "Start Date" }, { "name": "EndDate", "title": "End Date" }, { "name": "Undeletable", "title": "System-Reserved" }, { "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": { "DisplayName": "Holidays", "ObjectId": "b9c01804-a121-4a3e-ab54-1224563e4870", "hierarchy": "5f3ae552ce894e00120537fa", "OwnerLocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2", "URI": "/vmrest/schedules/b9c01804-a121-4a3e-ab54-1224563e4870", "OwnerLocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2", "IsHoliday": true, "ScheduleDetailsURI": "/vmrest/schedules/b9c01804-a121-4a3e-ab54-1224563e4870/scheduledetails", "hierarchy_friendly_name": "AB_Group (Customer)", "summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group", "Undeletable": true, "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group" } }, { "pkid": "5f3ae789ce894e001205a994", "meta": { "tags": [], "cached": true, "title": "Sync Schedule", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5f3ae59cce894e00120554b1", "href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1" } ], "self": [ { "pkid": "5f3ae789ce894e001205a994", "href": "/api/relation/CucScheduleREL/5f3ae789ce894e001205a994/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/relation/CucScheduleREL/5f3ae789ce894e001205a994/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/relation/CucScheduleREL/5f3ae789ce894e001205a994/", "class": "delete", "title": "Delete" } }, { "move": { "title": "Move", "support_async": true, "method": "POST", "href": "/api/tool/DataMove/5f3ae789ce894e001205a994/?model_type=relation/CucScheduleREL", "class": "move", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "method": "GET", "href": "/api/relation/CucScheduleREL/5f3ae789ce894e001205a994/export/", "class": "export", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "class": "tag", "href": "/api/relation/CucScheduleREL/5f3ae789ce894e001205a994/+tag/", "method": "PATCH", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "title": "Tag Version", "support_async": true, "class": "tag_version", "href": "/api/relation/CucScheduleREL/5f3ae789ce894e001205a994/+tag_version/", "method": "PATCH", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/relation/CucScheduleREL/5f3ae789ce894e001205a994/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/relation/CucScheduleREL/5f3ae789ce894e001205a994/help", "class": "help", "title": "Help" } }, { "AddDetail": { "title": "Add Detail", "support_async": true, "submit": "payload", "method": "POST", "href": "/api/relation/CucScheduleREL/5f3ae789ce894e001205a994/+AddDetail/", "class": "add", "schema": "Detail" } }, { "DelDetail": { "title": "Del Detail", "support_async": true, "submit": "payload", "method": "POST", "href": "/api/relation/CucScheduleREL/5f3ae789ce894e001205a994/+DelDetail/", "class": "delete", "schema": "Detail" } } ], "model_type": "relation/CucScheduleREL", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae789ce894e001205a994" ], "summary_attrs": [ { "name": "DisplayName", "title": "Schedule Display Name" }, { "name": "StartDate", "title": "Start Date" }, { "name": "EndDate", "title": "End Date" }, { "name": "Undeletable", "title": "System-Reserved" }, { "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": { "DisplayName": "Sync Schedule", "OwnerSubscriberObjectId": "00d60898-da5e-4e91-ab0d-b54a460833c0", "ObjectId": "4e187a22-0d8a-4d80-9f5f-0b45641815c8", "hierarchy": "5f3ae552ce894e00120537fa", "IsHoliday": false, "URI": "/vmrest/schedules/4e187a22-0d8a-4d80-9f5f-0b45641815c8", "ScheduleDetailsURI": "/vmrest/schedules/4e187a22-0d8a-4d80-9f5f-0b45641815c8/scheduledetails", "OwnerUserURI": "/vmrest/users/00d60898-da5e-4e91-ab0d-b54a460833c0", "hierarchy_friendly_name": "AB_Group (Customer)", "summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group", "Undeletable": false, "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group" } } ] }
(Show the first instance)
{ "pkid": "5f3ae786ce894e001205a92f", "meta": { "tags": [], "cached": true, "cache_control_policy": "cache_then_device", "title": "All Hours", "business_key": {}, "schema_version": "1.1", "references": { "device": [ { "pkid": "5f3ae59cce894e00120554b1", "href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1" } ], "self": [ { "pkid": "5f3ae786ce894e001205a92f", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/" } ], "children": [], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3ae786ce894e001205a92f/?hierarchy=[hierarchy]&model_type=relation/CucScheduleREL", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/+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/relation/CucScheduleREL/5f3ae786ce894e001205a92f/+tag_version/?hierarchy=[hierarchy]", "class": "tag_version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "AddDetail": { "title": "Add Detail", "support_async": true, "submit": "payload", "class": "add", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/+AddDetail/?hierarchy=[hierarchy]", "method": "POST", "schema": "Detail" } }, { "DelDetail": { "title": "Del Detail", "support_async": true, "submit": "payload", "class": "delete", "href": "/api/relation/CucScheduleREL/5f3ae786ce894e001205a92f/+DelDetail/?hierarchy=[hierarchy]", "method": "POST", "schema": "Detail" } } ], "model_type": "relation/CucScheduleREL", "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": "21.2", "tagged_versions": [] }, "data": { "Set": { "DisplayName": "All Hours", "ObjectId": "b60fffb2-d0bb-4470-b02a-6d48d95db838", "OwnerLocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2", "URI": "/vmrest/schedulesets/b60fffb2-d0bb-4470-b02a-6d48d95db838", "OwnerLocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2", "ScheduleSetMembersURI": "/vmrest/schedulesets/b60fffb2-d0bb-4470-b02a-6d48d95db838/schedulesetmembers", "Undeletable": true }, "DisplayName": "All Hours", "ObjectId": "768f15b6-92de-44bf-b3d7-fa7a924ddd96", "Detail": [ { "IsActiveSaturday": true, "IsActiveSunday": true, "ScheduleObjectId": "768f15b6-92de-44bf-b3d7-fa7a924ddd96", "ObjectId": "afdd5e34-500e-4df2-b0af-c3ccb57c261b", "IsActiveMonday": true, "IsActiveWednesday": true, "ScheduleURI": "/vmrest/schedules/768f15b6-92de-44bf-b3d7-fa7a924ddd96", "URI": "/vmrest/schedules/768f15b6-92de-44bf-b3d7-fa7a924ddd96/scheduledetails/afdd5e34-500e-4df2-b0af-c3ccb57c261b", "EndOfDay": false, "IsActiveTuesday": true, "IsActiveFriday": true, "StartTime": 0, "IsActiveThursday": true, "EndTime": 0 } ], "OwnerLocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2", "URI": "/vmrest/schedules/768f15b6-92de-44bf-b3d7-fa7a924ddd96", "OwnerLocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2", "IsHoliday": false, "ScheduleDetailsURI": "/vmrest/schedules/768f15b6-92de-44bf-b3d7-fa7a924ddd96/scheduledetails", "Undeletable": true } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for relation/CucScheduleREL. | GET | /api/relation/CucScheduleREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/CucScheduleREL as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/relation/CucScheduleREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/relation/CucScheduleREL/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/CucScheduleREL | 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 relation/CucScheduleREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/CucScheduleREL/[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 relation/CucScheduleREL and the JSON format can be used to import instances of relation/CucScheduleREL.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/relation/CucScheduleREL/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/relation/CucScheduleREL/[pkid] | hierarchy=[hierarchy] | The relation/CucScheduleREL instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/relation/CucScheduleREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/CucScheduleREL. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Add Detail | POST | /api/relation/CucScheduleREL/[pkid]/+AddDetail | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Del Detail | POST | /api/relation/CucScheduleREL/[pkid]/+DelDetail | hierarchy=[hierarchy] | If payload required: |