[Index]
Intermediate dial plan model input data.
Model ref.: data/DP_IntermediateDialPlanData
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{ "$schema": "http://json-schema.org/draft-03/schema", "type": "object", "properties": { "name": { "default": "{{ data.HierarchyNode.name || direction:local }} Dial Plan Input Data", "type": "string", "description": "Intermediate Dial Plan Input Data Friendly Name", "title": "Name" }, "extBO": { "type": "string", "description": "Digit dialed to break out to PSTN: Use Macro - macro.DP_Intermediate_PSTNAccess", "title": "External Breakout Number" }, "pNum": { "type": "string", "description": "Published Number for Site - macro.DP_Intermediate_PNum", "title": "Published Number" }, "eNum": { "type": "string", "description": "Emergency Call Back Number - macro.DP_Intermediate_ENum", "title": "Emergency Call Back Number" }, "dpDialPlan": { "type": "string", "description": "Choose the dial plan model which will be applied to the Intermediate elements ", "title": "Intermediate Dial Plan Model" }, "areaCodeArray": { "items": { "type": "object", "properties": { "dpPtnType": { "choices": [ { "value": "routepattern", "title": "Route Pattern" }, { "value": "transpattern", "title": "Translation Pattern" } ], "type": "string", "description": "Choose the type of local pattern used in Dial Plan", "title": "Dial Plan Pattern Type" }, "dpRPChoice": { "type": "string", "description": "Route pattern Model", "title": "Choose Route Pattern Model" }, "dpTPChoice": { "type": "string", "description": "Translation Pattern Model", "title": "Choose Translation Pattern Model" }, "areaCode": { "type": "string", "description": "Local region pstn area codes", "title": "Area Code" }, "exchange": { "type": "string", "description": "Exchange Data Available for pattern building", "title": "Exchange" } } }, "type": "array", "description": "Local region pstn area codes", "title": "Local Area Codes" }, "dpcv01": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal01", "title": "Dial Plan Custom Value 1" }, "dpcv02": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal02", "title": "Dial Plan Custom Value 2" }, "dpcv03": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal03", "title": "Dial Plan Custom Value 3" }, "dpcv04": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal04", "title": "Dial Plan Custom Value 4" }, "dpcv05": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal05", "title": "Dial Plan Custom Value 5" }, "dpcv06": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal06", "title": "Dial Plan Custom Value 6" }, "dpcv07": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal07", "title": "Dial Plan Custom Value 7" }, "dpcv08": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal08", "title": "Dial Plan Custom Value 8" }, "dpcv09": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal09", "title": "Dial Plan Custom Value 9" }, "dpcv10": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal10", "title": "Dial Plan Custom Value 10" }, "dpcv11": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal11", "title": "Dial Plan Custom Value 11" }, "dpcv12": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal12", "title": "Dial Plan Custom Value 12" }, "dpcv13": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal13", "title": "Dial Plan Custom Value 13" }, "dpcv14": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal14", "title": "Dial Plan Custom Value 14" }, "dpcv15": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal15", "title": "Dial Plan Custom Value 15" }, "dpcv16": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal16", "title": "Dial Plan Custom Value 16" }, "dpcv17": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal17", "title": "Dial Plan Custom Value 17" }, "dpcv18": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal18", "title": "Dial Plan Custom Value 18" }, "dpcv19": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal19", "title": "Dial Plan Custom Value 19" }, "dpcv20": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal20", "title": "Dial Plan Custom Value 20" }, "dpcv21": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal21", "title": "Dial Plan Custom Value 21" }, "dpcv22": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal22", "title": "Dial Plan Custom Value 22" }, "dpcv23": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal23", "title": "Dial Plan Custom Value 23" }, "dpcv24": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal24", "title": "Dial Plan Custom Value 24" }, "dpcv25": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal25", "title": "Dial Plan Custom Value 25" }, "dpcv26": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal26", "title": "Dial Plan Custom Value 26" }, "dpcv27": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal27", "title": "Dial Plan Custom Value 27" }, "dpcv28": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal28", "title": "Dial Plan Custom Value 28" }, "dpcv29": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal29", "title": "Dial Plan Custom Value 29" }, "dpcv30": { "type": "string", "description": "Dial Plan Custom Value - macro.DP_Intermediate_CVal30", "title": "Dial Plan Custom Value 30" }, "sipdestprim": { "type": "string", "description": "Primary SIP Trunk Destination IP Address - macro.DP_Intermediate_PrimarySIPAddr", "title": "Primary SIP Trunk Destination IP" }, "sipdestprimport": { "description": "Primary SIP Trunk Destination Port - macro.DP_Intermediate_PrimarySIPPort", "title": "Primary SIP Trunk Destination Port", "default": "5060", "choices": [ { "value": 5060, "title": "5060" }, { "value": 5061, "title": "5061/TLS" }, { "value": 5062, "title": "5062" }, { "value": 5063, "title": "5063" }, { "value": 5064, "title": "5064" }, { "value": 5065, "title": "5065" }, { "value": 5066, "title": "5066" }, { "value": 5067, "title": "5067" }, { "value": 5068, "title": "5068" }, { "value": 5069, "title": "5069" } ], "type": "string" }, "sipdestsec": { "type": "string", "description": "Secondary SIP Trunk Destination IP - macro.DP_Intermediate_SecondarySIPAddr", "title": "Secondary SIP Trunk Destination IP" }, "sipdestsecport": { "description": "Secondary SIP Trunk Destination Port - macro.DP_Intermediate_SecondarySIPPort", "title": "Secondary SIP Trunk Destination Port", "default": "5060", "choices": [ { "value": 5060, "title": "5060" }, { "value": 5061, "title": "5061/TLS" }, { "value": 5062, "title": "5062" }, { "value": 5063, "title": "5063" }, { "value": 5064, "title": "5064" }, { "value": 5065, "title": "5065" }, { "value": 5066, "title": "5066" }, { "value": 5067, "title": "5067" }, { "value": 5068, "title": "5068" }, { "value": 5069, "title": "5069" } ], "type": "string" }, "custCustID": { "type": "string", "description": "Custom Customer ID - macro.DP_Intermediate_CustomCustID", "title": "Custom Customer ID" }, "callParkCUCM": { "type": "string", "description": "Call Park Call Manager - macro.DP_Intermediate_CallParkCUCM", "title": "Call Park Call Manager" }, "sipdest03": { "type": "string", "description": "SIP Trunk Destination IP - macro.DP_Intermediate_SIPDest3", "title": "SIP Trunk Destination IP" }, "sipdestport03": { "description": "SIP Trunk Destination Port - macro.DP_Intermediate_SIPPort3", "title": "SIP Trunk Destination Port", "default": "5060", "choices": [ { "value": 5060, "title": "5060" }, { "value": 5061, "title": "5061/TLS" }, { "value": 5062, "title": "5062" }, { "value": 5063, "title": "5063" }, { "value": 5064, "title": "5064" }, { "value": 5065, "title": "5065" }, { "value": 5066, "title": "5066" }, { "value": 5067, "title": "5067" }, { "value": 5068, "title": "5068" }, { "value": 5069, "title": "5069" } ], "type": "string" }, "sipdest04": { "type": "string", "description": "SIP Trunk Destination IP - macro.DP_Intermediate_SIPDest4", "title": "SIP Trunk Destination IP" }, "sipdestport04": { "description": "SIP Trunk Destination Port - macro.DP_Intermediate_SIPPort4", "title": "SIP Trunk Destination Port", "default": "5060", "choices": [ { "value": 5060, "title": "5060" }, { "value": 5061, "title": "5061/TLS" }, { "value": 5062, "title": "5062" }, { "value": 5063, "title": "5063" }, { "value": 5064, "title": "5064" }, { "value": 5065, "title": "5065" }, { "value": 5066, "title": "5066" }, { "value": 5067, "title": "5067" }, { "value": 5068, "title": "5068" }, { "value": 5069, "title": "5069" } ], "type": "string" }, "sipdest05": { "type": "string", "description": "SIP Trunk Destination IP - macro.DP_Intermediate_SIPDest5", "title": "SIP Trunk Destination IP" }, "sipdestport05": { "description": "SIP Trunk Destination Port - macro.DP_Intermediate_SIPPort5", "title": "SIP Trunk Destination Port", "default": "5060", "choices": [ { "value": 5060, "title": "5060" }, { "value": 5061, "title": "5061/TLS" }, { "value": 5062, "title": "5062" }, { "value": 5063, "title": "5063" }, { "value": 5064, "title": "5064" }, { "value": 5065, "title": "5065" }, { "value": 5066, "title": "5066" }, { "value": 5067, "title": "5067" }, { "value": 5068, "title": "5068" }, { "value": 5069, "title": "5069" } ], "type": "string" }, "sipdest06": { "type": "string", "description": "SIP Trunk Destination IP - macro.DP_Intermediate_SIPDest6", "title": "SIP Trunk Destination IP" }, "sipdestport06": { "description": "SIP Trunk Destination Port - macro.DP_Intermediate_SIPPort6", "title": "SIP Trunk Destination Port", "default": "5060", "choices": [ { "value": 5060, "title": "5060" }, { "value": 5061, "title": "5061/TLS" }, { "value": 5062, "title": "5062" }, { "value": 5063, "title": "5063" }, { "value": 5064, "title": "5064" }, { "value": 5065, "title": "5065" }, { "value": 5066, "title": "5066" }, { "value": 5067, "title": "5067" }, { "value": 5068, "title": "5068" }, { "value": 5069, "title": "5069" } ], "type": "string" }, "sipdest07": { "type": "string", "description": "SIP Trunk Destination IP - macro.DP_Intermediate_SIPDest7", "title": "SIP Trunk Destination IP" }, "sipdestport07": { "description": "SIP Trunk Destination Port - macro.DP_Intermediate_SIPPort7", "title": "SIP Trunk Destination Port", "default": "5060", "choices": [ { "value": 5060, "title": "5060" }, { "value": 5061, "title": "5061/TLS" }, { "value": 5062, "title": "5062" }, { "value": 5063, "title": "5063" }, { "value": 5064, "title": "5064" }, { "value": 5065, "title": "5065" }, { "value": 5066, "title": "5066" }, { "value": 5067, "title": "5067" }, { "value": 5068, "title": "5068" }, { "value": 5069, "title": "5069" } ], "type": "string" }, "sipdest08": { "type": "string", "description": "SIP Trunk Destination IP - macro.DP_Intermediate_SIPDest8", "title": "SIP Trunk Destination IP" }, "sipdestport08": { "description": "SIP Trunk Destination Port - macro.DP_Intermediate_SIPPort8", "title": "SIP Trunk Destination Port", "default": "5060", "choices": [ { "value": 5060, "title": "5060" }, { "value": 5061, "title": "5061/TLS" }, { "value": 5062, "title": "5062" }, { "value": 5063, "title": "5063" }, { "value": 5064, "title": "5064" }, { "value": 5065, "title": "5065" }, { "value": 5066, "title": "5066" }, { "value": 5067, "title": "5067" }, { "value": 5068, "title": "5068" }, { "value": 5069, "title": "5069" } ], "type": "string" }, "sipdest09": { "type": "string", "description": "SIP Trunk Destination IP - macro.DP_Intermediate_SIPDest9", "title": "SIP Trunk Destination IP" }, "sipdestport09": { "description": "SIP Trunk Destination Port - macro.DP_Intermediate_SIPPort9", "title": "SIP Trunk Destination Port", "default": "5060", "choices": [ { "value": 5060, "title": "5060" }, { "value": 5061, "title": "5061/TLS" }, { "value": 5062, "title": "5062" }, { "value": 5063, "title": "5063" }, { "value": 5064, "title": "5064" }, { "value": 5065, "title": "5065" }, { "value": 5066, "title": "5066" }, { "value": 5067, "title": "5067" }, { "value": 5068, "title": "5068" }, { "value": 5069, "title": "5069" } ], "type": "string" }, "sipdest10": { "type": "string", "description": "SIP Trunk Destination IP - macro.DP_Intermediate_SIPDest10", "title": "SIP Trunk Destination IP" }, "sipdestport310": { "description": "SIP Trunk Destination Port - macro.DP_Intermediate_SIPPort10", "title": "SIP Trunk Destination Port", "default": "5060", "choices": [ { "value": 5060, "title": "5060" }, { "value": 5061, "title": "5061/TLS" }, { "value": 5062, "title": "5062" }, { "value": 5063, "title": "5063" }, { "value": 5064, "title": "5064" }, { "value": 5065, "title": "5065" }, { "value": 5066, "title": "5066" }, { "value": 5067, "title": "5067" }, { "value": 5068, "title": "5068" }, { "value": 5069, "title": "5069" } ], "type": "string" } }, "schema_version": "0.1" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/DP_IntermediateDialPlanData/add/ |
|
The GUI Add form of data/DP_IntermediateDialPlanData 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_IntermediateDialPlanData | 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_IntermediateDialPlanData/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/DP_IntermediateDialPlanData/[pkid1]", "/api/data/DP_IntermediateDialPlanData/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/DP_IntermediateDialPlanData/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/data/DP_IntermediateDialPlanData/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/data/DP_IntermediateDialPlanData/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/DP_IntermediateDialPlanData/[pkid1]", "/api/v0/data/DP_IntermediateDialPlanData/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/DP_IntermediateDialPlanData/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/DP_IntermediateDialPlanData; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/DP_IntermediateDialPlanData/export/ |
|
{ "hrefs":["/api/data/DP_IntermediateDialPlanData/[pkid1]", "/api/data/DP_IntermediateDialPlanData/[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_IntermediateDialPlanData and the JSON format can be used to import instances of data/DP_IntermediateDialPlanData.
GET http://[host-proxy]/api/data/DP_IntermediateDialPlanData/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/DP_IntermediateDialPlanData | POST | /api/data/DP_IntermediateDialPlanData/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Tag | PATCH | /api/data/DP_IntermediateDialPlanData/+tag/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Tag Version | PATCH | /api/data/DP_IntermediateDialPlanData/+tag_version/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/data/DP_IntermediateDialPlanData/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_IntermediateDialPlanData/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Migration Template | GET | /api/data/DP_IntermediateDialPlanData/migration/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/DP_IntermediateDialPlanData/ |
|
The data/DP_IntermediateDialPlanData schema and all instances as JSON. |
(The list will return 0 to 3 data/DP_IntermediateDialPlanData instances)
{ "pagination": { "skip": 0, "limit": 3, "maximum_limit": 2000, "total": 0, "total_limit": null, "order_by": "name", "direction": "asc", "current": "/api/data/DP_IntermediateDialPlanData/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree" }, "operations": [ "field_display_policy", "update", "help", "remove", "move", "add", "export", "list", "configuration_template", "get", "bulk_update_form", "migration", "transform", "export_bulkload_template" ], "meta": { "model_type": "data/DP_IntermediateDialPlanData", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "extBO", "title": "External Breakout Number" }, { "name": "pNum", "title": "Published Number" }, { "name": "eNum", "title": "Emergency Call Back Number" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "", "business_key": {}, "api_version": "21.2", "cached": true, "references": { "children": [], "parent": [ { "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101", "pkid": "6t0ggef2c0deab00hb595101" } ], "device": [ { "href": "", "pkid": "" } ], "foreign_key": [] }, "model_specific_actions": [ "add", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "get", "help", "list", "migration", "transform", "remove", "tag", "tag_version", "update" ], "schema_version": "0.1", "actions": [ { "add": { "method": "GET", "class": "add", "href": "/api/data/DP_IntermediateDialPlanData/add/?hierarchy=[hierarchy]", "support_async": false, "title": "Add" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/DP_IntermediateDialPlanData/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "bulk_update_form": { "method": "GET", "class": "update", "href": "/api/data/DP_IntermediateDialPlanData/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "support_async": false, "title": "Bulk Modify" } }, { "export": { "method": "POST", "class": "export", "href": "/api/data/DP_IntermediateDialPlanData/export/?hierarchy=[hierarchy]", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/?auth_token=[authtoken], "submit": "payload" } }, { "export_bulkload_template": { "method": "POST", "class": "bulkload_template", "href": "/api/data/DP_IntermediateDialPlanData/export_bulkload_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Export Bulk Load Template" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/DP_IntermediateDialPlanData/+tag/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/DP_IntermediateDialPlanData/+tag_version/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "method": "GET", "class": "config", "href": "/api/data/DP_IntermediateDialPlanData/configuration_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Configuration Template" } }, { "field_display_policy": { "method": "GET", "class": "display_policy", "href": "/api/data/DP_IntermediateDialPlanData/field_display_policy/?hierarchy=[hierarchy]", "support_async": false, "title": "Field Display Policy" } }, { "migration": { "method": "GET", "class": "migration", "href": "/api/data/DP_IntermediateDialPlanData/migration/?hierarchy=[hierarchy]", "support_async": false, "title": "Migration Template" } }, { "list": { "method": "GET", "class": "list", "href": "/api/data/DP_IntermediateDialPlanData/?hierarchy=[hierarchy]", "support_async": false, "title": "List" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/DP_IntermediateDialPlanData/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } }, { "transform": { "method": "GET", "class": "transform", "href": "/api/data/DP_IntermediateDialPlanData/transform/?hierarchy=[hierarchy]", "support_async": false, "title": "Transform Template" } } ] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/DP_IntermediateDialPlanData. | GET | /api/data/DP_IntermediateDialPlanData/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/DP_IntermediateDialPlanData as HTML |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Transform Template | GET | /api/data/DP_IntermediateDialPlanData/transform/ |
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/DP_IntermediateDialPlanData/[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_IntermediateDialPlanData/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/DP_IntermediateDialPlanData/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/DP_IntermediateDialPlanData/?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_IntermediateDialPlanData; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/DP_IntermediateDialPlanData/[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_IntermediateDialPlanData and the JSON format can be used to import instances of data/DP_IntermediateDialPlanData.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/data/DP_IntermediateDialPlanData/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/DP_IntermediateDialPlanData/[pkid] | hierarchy=[hierarchy] | The data/DP_IntermediateDialPlanData instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/DP_IntermediateDialPlanData/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/DP_IntermediateDialPlanData. |
Hi, how can I help you?