[Index]
Model ref.: device/cucm/TimePeriod
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": { "dayOfMonth": { "title": "Day of Month", "minItems": 0, "required": false, "default": 0, "maxItems": 1, "type": "integer" }, "name": { "description": "Enter a name in the Time Period Name field. The name can comprise up to 50 alphanumeric characters and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Ensure each time period name is unique to the plan. \n \n \n \n Note\u00a0\u00a0\u00a0 \n Use concise and descriptive names for your time periods. The hours_or_days format usually provides a sufficient level of detail and is short enough to enable you to quickly and easily identify a time period. For example, office_M_to_F identifies a time period for the business hours of an office from Monday to Friday. \n \n \n \n Cisco Unified Communications Manager provides the All the time\u00a0time period. This special, system time period includes all hours, is published to end users, and cannot be deleted; this time period can be copied. ", "title": "Name", "minItems": 1, "required": true, "maxItems": 1, "maxLength": 50, "type": "string" }, "endDay": { "title": "Day of Week End", "minItems": 0, "required": false, "choices": [ { "value": "Sun", "title": "Sun" }, { "value": "Mon", "title": "Mon" }, { "value": "Tue", "title": "Tue" }, { "value": "Wed", "title": "Wed" }, { "value": "Thu", "title": "Thu" }, { "value": "Fri", "title": "Fri" }, { "value": "Sat", "title": "Sat" }, { "value": "None", "title": "None" } ], "default": "None", "maxItems": 1, "type": "string" }, "startDay": { "title": "Day of Week Start", "minItems": 0, "required": false, "choices": [ { "value": "Sun", "title": "Sun" }, { "value": "Mon", "title": "Mon" }, { "value": "Tue", "title": "Tue" }, { "value": "Wed", "title": "Wed" }, { "value": "Thu", "title": "Thu" }, { "value": "Fri", "title": "Fri" }, { "value": "Sat", "title": "Sat" }, { "value": "None", "title": "None" } ], "default": "None", "maxItems": 1, "type": "string" }, "isPublished": { "description": "TimePeriod cannot be published if it has a todOwnerId assigned to it. Only Administrative Time Period can be published.", "title": "Is Published", "minItems": 0, "required": false, "maxItems": 1, "type": "boolean" }, "monthOfYearEnd": { "title": "Month of Year End", "minItems": 0, "required": false, "choices": [ { "value": "None", "title": "None" }, { "value": "Jan", "title": "Jan" }, { "value": "Feb", "title": "Feb" }, { "value": "Mar", "title": "Mar" }, { "value": "Apr", "title": "Apr" }, { "value": "May", "title": "May" }, { "value": "Jun", "title": "Jun" }, { "value": "Jul", "title": "Jul" }, { "value": "Aug", "title": "Aug" }, { "value": "Sep", "title": "Sep" }, { "value": "Oct", "title": "Oct" }, { "value": "Nov", "title": "Nov" }, { "value": "Dec", "title": "Dec" } ], "default": "None", "maxItems": 1, "type": "string" }, "monthOfYear": { "title": "Month Of Year", "minItems": 0, "required": false, "choices": [ { "value": "None", "title": "None" }, { "value": "Jan", "title": "Jan" }, { "value": "Feb", "title": "Feb" }, { "value": "Mar", "title": "Mar" }, { "value": "Apr", "title": "Apr" }, { "value": "May", "title": "May" }, { "value": "Jun", "title": "Jun" }, { "value": "Jul", "title": "Jul" }, { "value": "Aug", "title": "Aug" }, { "value": "Sep", "title": "Sep" }, { "value": "Oct", "title": "Oct" }, { "value": "Nov", "title": "Nov" }, { "value": "Dec", "title": "Dec" } ], "default": "None", "maxItems": 1, "type": "string" }, "startTime": { "description": "From the drop-down list box, choose the time when this time period starts. The available listed start times comprise 15-minute intervals throughout a 24-hour day. The default value is No Office Hours. \n \n \n \n Note\u00a0\u00a0\u00a0 \n To start a time period at midnight, choose the 00:00 value. \n \n \n ", "title": "Time Of Day Start", "minItems": 0, "required": false, "choices": [ { "value": "No Office Hours", "title": "No Office Hours" }, { "value": "00:00", "title": "00:00" }, { "value": "00:15", "title": "00:15" }, { "value": "00:30", "title": "00:30" }, { "value": "00:45", "title": "00:45" }, { "value": "01:00", "title": "01:00" }, { "value": "01:15", "title": "01:15" }, { "value": "01:30", "title": "01:30" }, { "value": "01:45", "title": "01:45" }, { "value": "02:00", "title": "02:00" }, { "value": "02:15", "title": "02:15" }, { "value": "02:30", "title": "02:30" }, { "value": "02:45", "title": "02:45" }, { "value": "03:00", "title": "03:00" }, { "value": "03:15", "title": "03:15" }, { "value": "03:30", "title": "03:30" }, { "value": "03:45", "title": "03:45" }, { "value": "04:00", "title": "04:00" }, { "value": "04:15", "title": "04:15" }, { "value": "04:30", "title": "04:30" }, { "value": "04:45", "title": "04:45" }, { "value": "05:00", "title": "05:00" }, { "value": "05:15", "title": "05:15" }, { "value": "05:30", "title": "05:30" }, { "value": "05:45", "title": "05:45" }, { "value": "06:00", "title": "06:00" }, { "value": "06:15", "title": "06:15" }, { "value": "06:30", "title": "06:30" }, { "value": "06:45", "title": "06:45" }, { "value": "07:00", "title": "07:00" }, { "value": "07:15", "title": "07:15" }, { "value": "07:30", "title": "07:30" }, { "value": "07:45", "title": "07:45" }, { "value": "08:00", "title": "08:00" }, { "value": "08:15", "title": "08:15" }, { "value": "08:30", "title": "08:30" }, { "value": "08:45", "title": "08:45" }, { "value": "09:00", "title": "09:00" }, { "value": "09:15", "title": "09:15" }, { "value": "09:30", "title": "09:30" }, { "value": "09:45", "title": "09:45" }, { "value": "10:00", "title": "10:00" }, { "value": "10:15", "title": "10:15" }, { "value": "10:30", "title": "10:30" }, { "value": "10:45", "title": "10:45" }, { "value": "11:00", "title": "11:00" }, { "value": "11:15", "title": "11:15" }, { "value": "11:30", "title": "11:30" }, { "value": "11:45", "title": "11:45" }, { "value": "12:00", "title": "12:00" }, { "value": "12:15", "title": "12:15" }, { "value": "12:30", "title": "12:30" }, { "value": "12:45", "title": "12:45" }, { "value": "13:00", "title": "13:00" }, { "value": "13:15", "title": "13:15" }, { "value": "13:30", "title": "13:30" }, { "value": "13:45", "title": "13:45" }, { "value": "14:00", "title": "14:00" }, { "value": "14:15", "title": "14:15" }, { "value": "14:30", "title": "14:30" }, { "value": "14:45", "title": "14:45" }, { "value": "15:00", "title": "15:00" }, { "value": "15:15", "title": "15:15" }, { "value": "15:30", "title": "15:30" }, { "value": "15:45", "title": "15:45" }, { "value": "16:00", "title": "16:00" }, { "value": "16:15", "title": "16:15" }, { "value": "16:30", "title": "16:30" }, { "value": "16:45", "title": "16:45" }, { "value": "17:00", "title": "17:00" }, { "value": "17:15", "title": "17:15" }, { "value": "17:30", "title": "17:30" }, { "value": "17:45", "title": "17:45" }, { "value": "18:00", "title": "18:00" }, { "value": "18:15", "title": "18:15" }, { "value": "18:30", "title": "18:30" }, { "value": "18:45", "title": "18:45" }, { "value": "19:00", "title": "19:00" }, { "value": "19:15", "title": "19:15" }, { "value": "19:30", "title": "19:30" }, { "value": "19:45", "title": "19:45" }, { "value": "20:00", "title": "20:00" }, { "value": "20:15", "title": "20:15" }, { "value": "20:30", "title": "20:30" }, { "value": "20:45", "title": "20:45" }, { "value": "21:00", "title": "21:00" }, { "value": "21:15", "title": "21:15" }, { "value": "21:30", "title": "21:30" }, { "value": "21:45", "title": "21:45" }, { "value": "22:00", "title": "22:00" }, { "value": "22:15", "title": "22:15" }, { "value": "22:30", "title": "22:30" }, { "value": "22:45", "title": "22:45" }, { "value": "23:00", "title": "23:00" }, { "value": "23:15", "title": "23:15" }, { "value": "23:30", "title": "23:30" }, { "value": "23:45", "title": "23:45" }, { "value": "24:00", "title": "24:00" } ], "default": "No Office Hours", "maxItems": 1, "type": "string" }, "dayOfMonthEnd": { "title": "Day of Month End", "minItems": 0, "required": false, "default": 0, "maxItems": 1, "type": "integer" }, "todOwnerIdName": { "target": "/api/device/cucm/User/choices/?field=userid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "minItems": 0, "required": false, "choices": [], "target_attr": "userid", "maxItems": 1, "target_model_type": "device/cucm/User", "title": "Tod Owner Id Name", "type": [ "string", "null" ] }, "endTime": { "description": "From the drop-down list box, choose the time when this time period ends. The available listed end times comprise 15-minute intervals throughout a 24-hour day. The default value is No Office Hours. \n \n \n \n Note\u00a0\u00a0\u00a0 \n You must choose an End Time that is later than the Start Time that you chose. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n To end a time period at midnight, choose the 24:00 value. \n \n \n ", "title": "Time of Day End", "minItems": 0, "required": false, "choices": [ { "value": "No Office Hours", "title": "No Office Hours" }, { "value": "00:00", "title": "00:00" }, { "value": "00:15", "title": "00:15" }, { "value": "00:30", "title": "00:30" }, { "value": "00:45", "title": "00:45" }, { "value": "01:00", "title": "01:00" }, { "value": "01:15", "title": "01:15" }, { "value": "01:30", "title": "01:30" }, { "value": "01:45", "title": "01:45" }, { "value": "02:00", "title": "02:00" }, { "value": "02:15", "title": "02:15" }, { "value": "02:30", "title": "02:30" }, { "value": "02:45", "title": "02:45" }, { "value": "03:00", "title": "03:00" }, { "value": "03:15", "title": "03:15" }, { "value": "03:30", "title": "03:30" }, { "value": "03:45", "title": "03:45" }, { "value": "04:00", "title": "04:00" }, { "value": "04:15", "title": "04:15" }, { "value": "04:30", "title": "04:30" }, { "value": "04:45", "title": "04:45" }, { "value": "05:00", "title": "05:00" }, { "value": "05:15", "title": "05:15" }, { "value": "05:30", "title": "05:30" }, { "value": "05:45", "title": "05:45" }, { "value": "06:00", "title": "06:00" }, { "value": "06:15", "title": "06:15" }, { "value": "06:30", "title": "06:30" }, { "value": "06:45", "title": "06:45" }, { "value": "07:00", "title": "07:00" }, { "value": "07:15", "title": "07:15" }, { "value": "07:30", "title": "07:30" }, { "value": "07:45", "title": "07:45" }, { "value": "08:00", "title": "08:00" }, { "value": "08:15", "title": "08:15" }, { "value": "08:30", "title": "08:30" }, { "value": "08:45", "title": "08:45" }, { "value": "09:00", "title": "09:00" }, { "value": "09:15", "title": "09:15" }, { "value": "09:30", "title": "09:30" }, { "value": "09:45", "title": "09:45" }, { "value": "10:00", "title": "10:00" }, { "value": "10:15", "title": "10:15" }, { "value": "10:30", "title": "10:30" }, { "value": "10:45", "title": "10:45" }, { "value": "11:00", "title": "11:00" }, { "value": "11:15", "title": "11:15" }, { "value": "11:30", "title": "11:30" }, { "value": "11:45", "title": "11:45" }, { "value": "12:00", "title": "12:00" }, { "value": "12:15", "title": "12:15" }, { "value": "12:30", "title": "12:30" }, { "value": "12:45", "title": "12:45" }, { "value": "13:00", "title": "13:00" }, { "value": "13:15", "title": "13:15" }, { "value": "13:30", "title": "13:30" }, { "value": "13:45", "title": "13:45" }, { "value": "14:00", "title": "14:00" }, { "value": "14:15", "title": "14:15" }, { "value": "14:30", "title": "14:30" }, { "value": "14:45", "title": "14:45" }, { "value": "15:00", "title": "15:00" }, { "value": "15:15", "title": "15:15" }, { "value": "15:30", "title": "15:30" }, { "value": "15:45", "title": "15:45" }, { "value": "16:00", "title": "16:00" }, { "value": "16:15", "title": "16:15" }, { "value": "16:30", "title": "16:30" }, { "value": "16:45", "title": "16:45" }, { "value": "17:00", "title": "17:00" }, { "value": "17:15", "title": "17:15" }, { "value": "17:30", "title": "17:30" }, { "value": "17:45", "title": "17:45" }, { "value": "18:00", "title": "18:00" }, { "value": "18:15", "title": "18:15" }, { "value": "18:30", "title": "18:30" }, { "value": "18:45", "title": "18:45" }, { "value": "19:00", "title": "19:00" }, { "value": "19:15", "title": "19:15" }, { "value": "19:30", "title": "19:30" }, { "value": "19:45", "title": "19:45" }, { "value": "20:00", "title": "20:00" }, { "value": "20:15", "title": "20:15" }, { "value": "20:30", "title": "20:30" }, { "value": "20:45", "title": "20:45" }, { "value": "21:00", "title": "21:00" }, { "value": "21:15", "title": "21:15" }, { "value": "21:30", "title": "21:30" }, { "value": "21:45", "title": "21:45" }, { "value": "22:00", "title": "22:00" }, { "value": "22:15", "title": "22:15" }, { "value": "22:30", "title": "22:30" }, { "value": "22:45", "title": "22:45" }, { "value": "23:00", "title": "23:00" }, { "value": "23:15", "title": "23:15" }, { "value": "23:30", "title": "23:30" }, { "value": "23:45", "title": "23:45" }, { "value": "24:00", "title": "24:00" } ], "default": "No Office Hours", "maxItems": 1, "type": "string" }, "description": { "description": "Enter a description for this time period. ", "title": "Description", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 255, "type": "string" } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/cucm/TimePeriod/add/ |
|
The GUI Add form of device/cucm/TimePeriod 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/cucm/TimePeriod | 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/cucm/TimePeriod/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cucm/TimePeriod/[pkid1]", "/api/device/cucm/TimePeriod/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cucm/TimePeriod/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cucm/TimePeriod/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cucm/TimePeriod/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/TimePeriod/[pkid1]", "/api/v0/device/cucm/TimePeriod/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/TimePeriod/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cucm/TimePeriod |
|
{"hrefs": ["/api/device/cucm/TimePeriod/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/TimePeriod |
|
{"hrefs": ["/api/device/cucm/TimePeriod/[pkid1]", "/api/device/cucm/TimePeriod/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/TimePeriod; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/TimePeriod/export/ |
|
{ "hrefs":["/api/device/cucm/TimePeriod/[pkid1]", "/api/device/cucm/TimePeriod/[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/cucm/TimePeriod and the JSON format can be used to import instances of device/cucm/TimePeriod.
GET http://[host-proxy]/api/device/cucm/TimePeriod/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cucm/TimePeriod | POST | /api/device/cucm/TimePeriod/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/cucm/TimePeriod/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/cucm/TimePeriod/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cucm/TimePeriod/ |
|
The device/cucm/TimePeriod schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/TimePeriod instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "move", "list", "update", "remove", "transform", "add", "export", "bulk_update_form" ], "pagination": { "direction": "asc", "order_by": "name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cucm/TimePeriod/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 7 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "14.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/cucm/TimePeriod/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cucm/TimePeriod/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cucm/TimePeriod/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/cucm/TimePeriod", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cucm/TimePeriod/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/cucm/TimePeriod/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cucm/TimePeriod/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cucm/TimePeriod/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cucm/TimePeriod/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cucm/TimePeriod/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cucm/TimePeriod/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cucm/TimePeriod", "model_specific_actions": [ "field_display_policy", "configuration_template", "help", "get", "clone", "move", "list", "update", "remove", "add", "export", "export_bulkload_template", "bulk_update_form" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "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": "5f3ae596ce894e001205531c", "meta": { "tags": [], "cached": true, "title": "All the time", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5f3ae58ace894e00120550c2", "href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2" } ], "self": [ { "pkid": "5f3ae596ce894e001205531c", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e001205531c/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e001205531c/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e001205531c/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e001205531c/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3ae596ce894e001205531c/?model_type=device/cucm/TimePeriod", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e001205531c/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e001205531c/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e001205531c/help", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e001205531c/purge/", "method": "POST", "title": "Purge" } } ], "model_type": "device/cucm/TimePeriod", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae596ce894e001205531c" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "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": { "endTime": "24:00", "dayOfMonth": 0, "name": "All the time", "hierarchy": "5f3ae552ce894e00120537fa", "endDay": "Sat", "startDay": "Sun", "isPublished": false, "monthOfYearEnd": "None", "monthOfYear": "None", "startTime": "00:00", "dayOfMonthEnd": 0, "todOwnerIdName": null, "summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group", "hierarchy_friendly_name": "AB_Group (Customer)", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group" } }, { "pkid": "5f3ae596ce894e0012055318", "meta": { "tags": [], "cached": true, "title": "Cu1-AfterHrs1-TPer", "business_key": {}, "schema_version": "", "summary": "false", "references": { "device": [ { "pkid": "5f3ae58ace894e00120550c2", "href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5f3ae596ce894e0012055318", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e0012055318/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e0012055318/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e0012055318/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "clone": { "support_async": false, "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e0012055318/clone/?schema=&schema_rules=true", "title": "Clone", "class": "clone", "method": "GET" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3ae596ce894e0012055318/?model_type=device/cucm/TimePeriod", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e0012055318/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e0012055318/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e0012055318/help", "title": "Help", "class": "help", "method": "GET" } }, { "purge": { "support_async": false, "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e0012055318/purge/", "title": "Purge", "class": "purge", "method": "POST" } } ], "model_type": "device/cucm/TimePeriod", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae596ce894e0012055318" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "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": { "endTime": "24:00", "dayOfMonth": 0, "description": "After Hours - 6pm to 12am", "endDay": "Fri", "startDay": "Mon", "isPublished": false, "monthOfYearEnd": "None", "monthOfYear": "None", "startTime": "18:00", "dayOfMonthEnd": 0, "summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group", "todOwnerIdName": null, "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group", "hierarchy_friendly_name": "AB_Group (Customer)", "name": "Cu1-AfterHrs1-TPer" } }, { "pkid": "5f3ae597ce894e0012055340", "meta": { "tags": [], "cached": true, "title": "Cu1-AfterHrs2-TPer", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5f3ae58ace894e00120550c2", "href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2" } ], "self": [ { "pkid": "5f3ae597ce894e0012055340", "href": "/api/device/cucm/TimePeriod/5f3ae597ce894e0012055340/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/device/cucm/TimePeriod/5f3ae597ce894e0012055340/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/device/cucm/TimePeriod/5f3ae597ce894e0012055340/", "class": "delete", "title": "Delete" } }, { "clone": { "support_async": false, "method": "GET", "href": "/api/device/cucm/TimePeriod/5f3ae597ce894e0012055340/clone/?schema=&schema_rules=true", "class": "clone", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "method": "POST", "href": "/api/tool/DataMove/5f3ae597ce894e0012055340/?model_type=device/cucm/TimePeriod", "class": "move", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "method": "GET", "href": "/api/device/cucm/TimePeriod/5f3ae597ce894e0012055340/export/", "class": "export", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/device/cucm/TimePeriod/5f3ae597ce894e0012055340/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/device/cucm/TimePeriod/5f3ae597ce894e0012055340/help", "class": "help", "title": "Help" } }, { "purge": { "support_async": false, "method": "POST", "href": "/api/device/cucm/TimePeriod/5f3ae597ce894e0012055340/purge/", "class": "purge", "title": "Purge" } } ], "model_type": "device/cucm/TimePeriod", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae597ce894e0012055340" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "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": { "endTime": "08:00", "dayOfMonth": 0, "description": "After Hours - 12am to 8am", "hierarchy": "5f3ae552ce894e00120537fa", "endDay": "Fri", "startDay": "Mon", "isPublished": false, "monthOfYearEnd": "None", "monthOfYear": "None", "startTime": "00:00", "dayOfMonthEnd": 0, "summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group", "todOwnerIdName": null, "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group", "hierarchy_friendly_name": "AB_Group (Customer)", "name": "Cu1-AfterHrs2-TPer" } } ] }
(Show the first instance)
{ "pkid": "5f3ae596ce894e001205531c", "meta": { "tags": [], "cached": true, "cache_control_policy": "cache_then_device", "title": "All the time", "business_key": {}, "schema_version": "11.5", "references": { "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "self": [ { "pkid": "5f3ae596ce894e001205531c", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e001205531c/" } ], "foreign_key": [], "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5f3ae58ace894e00120550c2", "href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e001205531c/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e001205531c/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e001205531c/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3ae596ce894e001205531c/?hierarchy=[hierarchy]&model_type=device/cucm/TimePeriod", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e001205531c/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e001205531c/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e001205531c/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cucm/TimePeriod/5f3ae596ce894e001205531c/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cucm/TimePeriod", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae596ce894e001205531c" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "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": "All the time", "endDay": "Sat", "startDay": "Sun", "isPublished": false, "monthOfYearEnd": "None", "monthOfYear": "None", "startTime": "00:00", "dayOfMonthEnd": 0, "endTime": "24:00", "dayOfMonth": 0 } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/cucm/TimePeriod. | GET | /api/device/cucm/TimePeriod/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/TimePeriod as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/cucm/TimePeriod/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/cucm/TimePeriod/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/TimePeriod/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/TimePeriod/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/TimePeriod | 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/cucm/TimePeriod; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/TimePeriod/[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/cucm/TimePeriod and the JSON format can be used to import instances of device/cucm/TimePeriod.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cucm/TimePeriod/[pkid] | hierarchy=[hierarchy] | The device/cucm/TimePeriod instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cucm/TimePeriod/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/TimePeriod. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cucm/TimePeriod/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |