[Index]
Dial Plan Time Period Data Model
Model ref.: data/DP_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": { "dpName": { "required": true, "type": "string", "description": "The name for this Dial Plan.", "title": "Dial Plan Name" }, "tod_start": { "description": "Time of Day Start", "title": "Time of Day Start", "default": "No Office Hours", "required": true, "choices": [ { "value": "No Office Hours", "title": "No Office Hours" } ], "type": "any" }, "tod_end_day_of_month": { "default": "0", "type": "integer", "description": "Optional end day of month for this period.", "title": "End Day of Month" }, "tod_end": { "description": "The end time for this period.", "title": "Time of Day End", "default": "No Office Hours", "required": true, "choices": [ { "value": "No Office Hours", "title": "No Office Hours" } ], "type": "any" }, "time_period_description": { "type": "string", "description": "A meaningful description for this time period.", "title": "Description" }, "tod_start_day": { "default": "None", "choices": [ { "value": "None", "title": "None" } ], "type": "string", "description": "Optional start day for this period.", "title": "Start Day" }, "tod_start_day_of_month": { "default": "0", "type": "integer", "description": "Optional start day of month for this period.", "title": "Start Day of Month" }, "tod_end_day": { "default": "None", "choices": [ { "value": "None", "title": "None" } ], "type": "string", "description": "Optional end day for this period.", "title": "End Day" }, "tod_start_month": { "default": "None", "choices": [ { "value": "None", "title": "None" } ], "type": "string", "description": "Optional start month for this period.", "title": "Start Month" }, "tod_end_month": { "default": "None", "choices": [ { "value": "None", "title": "None" } ], "type": "string", "description": "Optional end month for this period.", "title": "End Month" }, "name": { "required": true, "type": "string", "description": "The name for this time period.", "title": "Time Period Name" } }, "schema_version": "0.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/DP_TimePeriod/add/ |
|
The GUI Add form of data/DP_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/data/DP_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/data/DP_TimePeriod/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/DP_TimePeriod/[pkid1]", "/api/data/DP_TimePeriod/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/DP_TimePeriod/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/DP_TimePeriod; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/DP_TimePeriod/export/ |
|
{ "hrefs":["/api/data/DP_TimePeriod/[pkid1]", "/api/data/DP_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 data/DP_TimePeriod and the JSON format can be used to import instances of data/DP_TimePeriod.
GET http://[host-proxy]/api/data/DP_TimePeriod/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/DP_TimePeriod | POST | /api/data/DP_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/data/DP_TimePeriod/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/data/DP_TimePeriod/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/DP_TimePeriod/ |
|
The data/DP_TimePeriod schema and all instances as JSON. |
(The list will return 0 to 3 data/DP_TimePeriod instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "list", "update", "remove", "transform", "add", "export", "migration", "bulk_update_form" ], "pagination": { "direction": "asc", "order_by": "dpName", "maximum_limit": 2000, "skip": 0, "current": "/api/data/DP_TimePeriod/?skip=0&limit=3&order_by=dpName&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "? - ?", "business_key": { "hierarchy": true, "unique": [ "dpName", "name" ] }, "schema_version": "0.0", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/data/DP_TimePeriod/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/DP_TimePeriod/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/DP_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/data/DP_TimePeriod/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/DP_TimePeriod/+tag/?hierarchy=[hierarchy]", "class": "tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/data/DP_TimePeriod/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/data/DP_TimePeriod/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/data/DP_TimePeriod/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/DP_TimePeriod/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/DP_TimePeriod", "model_specific_actions": [ "add", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "get", "help", "list", "remove", "tag", "update" ], "summary_attrs": [ { "name": "dpName", "title": "Dial Plan Name" }, { "name": "name", "title": "Time Period Name" }, { "name": "time_period_description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/DP_TimePeriod. | GET | /api/data/DP_TimePeriod/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/DP_TimePeriod as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/DP_TimePeriod/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/DP_TimePeriod/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/DP_TimePeriod/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/DP_TimePeriod/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of data/DP_TimePeriod; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/DP_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 data/DP_TimePeriod and the JSON format can be used to import instances of data/DP_TimePeriod.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/data/DP_TimePeriod/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/DP_TimePeriod/[pkid]/ | hierarchy=[hierarchy] | The data/DP_TimePeriod instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/DP_TimePeriod/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/DP_TimePeriod. |