[Index]
Contains site specific information for dial plan.
Model ref.: data/DpSite
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": {
"siteName": {
"is_password": false,
"format": "uri",
"default": "{{ macro.HcsDpSiteName }}",
"required": true,
"displayable": false,
"target_attr": "SiteName",
"readonly": false,
"maxLength": 1024,
"title": "Site name",
"type": "string",
"target": "/api/data/BaseSiteDAT/choices/?field=SiteName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/BaseSiteDAT",
"choices": []
},
"custName": {
"is_password": false,
"description": "Specify the customer that owns this site",
"format": "uri",
"default": "{{ macro.HcsDpCustomerName }}",
"required": false,
"displayable": false,
"target_attr": "CustomerName",
"readonly": false,
"target": "/api/data/BaseCustomerDAT/choices/?field=CustomerName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"maxLength": 1024,
"title": "Customer",
"type": "string",
"target_model_type": "data/BaseCustomerDAT",
"choices": []
},
"ext": {
"is_password": false,
"description": "The external breakout number for the country associated with this site.",
"title": "External breakout number",
"pattern": "^$|^[0-9]*$",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1,
"type": "string"
},
"slc": {
"is_password": false,
"description": "Site location code can have a maximum of 8 digits.",
"title": "Site location code",
"pattern": "^$|^[0-9]+$",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 8,
"type": "string"
},
"extLen": {
"is_password": false,
"description": "Extensions can be from 1 to 30 digits in length.",
"title": "Extension length",
"default": "4",
"pattern": "^([1-9]|[12][0-9]|[3][0])$",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 2,
"type": "string"
},
"extPrefixReq": {
"is_password": false,
"description": "Indicates that this site will use the extension prefix as specified in the customer dial plan. If the extension prefix is not specified in the customer dial plan, this setting has no effect.",
"title": "Extension prefix required?",
"default": "false",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"areaCodeArray": {
"is_password": false,
"description": "Specify one or more area codes for this site.",
"title": "Area Codes",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"areaCode": {
"is_password": false,
"description": "An area code associated with this site.",
"title": "Area Code",
"pattern": "^[0-9#*]+$",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 8,
"type": "string"
},
"locNumLen": {
"is_password": false,
"description": "Length of the local numbers associated with this area code.",
"title": "Local Number Length",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 2,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"areaCodeInLocalDialing": {
"is_password": false,
"description": "Indicates whether area code is needed for local dialing.",
"title": "Area Code Used for Local Dialing",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"pubNumber": {
"is_password": false,
"description": "The site published number is the default E164 mask when a line is associated to a phone, device profile, or remote destination profile at a particular site. The default CUCM phone line E164 mask, default CUCM device profile line E164 mask, and the default CUCM remote destination profile line E164 mask in the site default doc are updated with this number, unless those default values in the site defaults doc have been manually updated to some other number. Furthermore, if any existing subscribers are using the site published number in their phone line E164 mask, device profile line E164 mask, or remote destination profile line E164 mask, that value is updated as well.",
"title": "Published number",
"pattern": "^$|^(\\\\\\+)?[0-9]+$|^\\+?[0-9]+$",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"emerNumber": {
"is_password": false,
"description": "The site emergency callback number is the calling number when initiating an outgoing emergency call. If you change the emergency callback number, the following calling party transformation patterns are updated to use the new value: *{{ macro.HcsDpSiteId}}*! and *{{ macro.HcsDpSiteId}}*\\+!",
"title": "Emergency number",
"pattern": "^$|^(\\\\\\+)?[0-9]+$|^\\+?[0-9]+$",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"siteId": {
"is_password": false,
"description": "Unique ID for this site",
"title": "Site ID",
"default": "{{ macro.HcsDpSiteId }}",
"required": true,
"displayable": false,
"readonly": true,
"maxLength": 1024,
"type": "string"
},
"active": {
"is_password": false,
"description": "Enable to activate the site.",
"title": "Site Active",
"default": "false",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"slcBased": {
"is_password": false,
"description": "Indicates whether or not Site Location Code is required for this customer. This value for this field taken from Customer Dial Plan model.",
"title": "Site-Location Code (SLC) Based Dial Plan",
"default": "{{ data.DpCustomer.slcBased }}",
"required": true,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"debug": {
"is_password": false,
"description": "Used to store store debug info and on-screen help information.",
"title": "Debug Info",
"default": "Default debug info",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"createEmerPattern": {
"is_password": false,
"description": "Use DDI for emergency calls when user is at home location",
"title": "Use DDI for emergency calls",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
}
},
"schema_version": "2.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/DpSite/add/ |
|
The GUI Add form of data/DpSite 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/DpSite | 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/DpSite/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/DpSite/[pkid1]", "/api/data/DpSite/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/DpSite/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/DpSite; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/DpSite/export/ |
|
{ "hrefs":["/api/data/DpSite/[pkid1]", "/api/data/DpSite/[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/DpSite and the JSON format can be used to import instances of data/DpSite.
GET http://[host-proxy]/api/data/DpSite/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/DpSite | POST | /api/data/DpSite/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/DpSite/ |
|
The data/DpSite schema and all instances as JSON. |
(The list will return 0 to 3 data/DpSite instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 28,
"total_limit": null,
"order_by": "siteName",
"direction": "asc",
"current": "/api/data/DpSite/?skip=0&limit=3&order_by=siteName&direction=asc&traversal=down"
},
"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/DpSite",
"summary_attrs": [
{
"name": "siteName",
"title": "Site name"
},
{
"name": "siteId",
"title": "Site ID"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {
"hierarchy": true,
"unique": [
"siteName"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"list",
"get",
"add",
"update",
"remove",
"import",
"execute",
"export",
"export_bulkload_template",
"help"
],
"schema_version": "2.5",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/DpSite/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/DpSite/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/DpSite/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/DpSite/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/DpSite/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/DpSite/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"extLen": "7",
"ext": "0",
"pkid": "5ae8a387affa931cce3a035c",
"siteName": "CL1-AB-C-Berlin",
"slcBased": false,
"emerNumber": "+494215380",
"custName": "AB_Group",
"active": true,
"areaCodeArray": [
{
"areaCode": "421",
"locNumLen": "8"
}
],
"extPrefixReq": false,
"siteId": "6",
"debug": "Valid Site created for AB_Group",
"pubNumber": "+494215380",
"areaCodeInLocalDialing": true,
"slc": "",
"hierarchy_friendly_name": "CL1-AB-C-Berlin (Site)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Berlin"
},
"meta": {
"model_type": "data/DpSite",
"summary_attrs": [
{
"name": "siteName",
"title": "Site name"
},
{
"name": "siteId",
"title": "Site ID"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "title format",
"business_key": {
"hierarchy": true,
"unique": [
"siteName"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae8a04aaffa931cce3910b5",
"href": "/api/data/HierarchyNode/5ae8a04aaffa931cce3910b5"
}
],
"foreign_key": [
{
"pkid": "5ae8a05caffa931cce3912db",
"path": "siteName",
"model_type": "data/BaseSiteDAT"
},
{
"pkid": "5ae89ea3affa931cce38a55c",
"path": "custName",
"model_type": "data/BaseCustomerDAT"
}
],
"self": [
{
"href": "/api/data/DpSite/5ae8a387affa931cce3a034f/",
"pkid": "5ae8a387affa931cce3a034f"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89f22affa931cce38d2f4",
"5ae8a04aaffa931cce3910b5",
"5ae8a387affa931cce3a034f"
],
"schema_version": "2.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/DpSite/5ae8a387affa931cce3a034f/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/DpSite/5ae8a387affa931cce3a034f/",
"support_async": true,
"title": "Delete"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/DpSite/5ae8a387affa931cce3a034f/import/",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/DpSite/5ae8a387affa931cce3a034f/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/DpSite/5ae8a387affa931cce3a034f/execute/",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/DpSite/5ae8a387affa931cce3a034f/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/DpSite/5ae8a387affa931cce3a034f/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ae8a387affa931cce3a034f"
},
{
"data": {
"extLen": "7",
"ext": "0",
"pkid": "5ae8a2c7affa931cce39abd1",
"siteName": "CL1-AB-C-Grenoble",
"slcBased": false,
"emerNumber": "+33561935556",
"custName": "AB_Group",
"active": true,
"areaCodeArray": [
{
"areaCode": "5",
"locNumLen": "8"
}
],
"extPrefixReq": false,
"siteId": "2",
"debug": "Valid Site created for AB_Group",
"pubNumber": "+33561935555",
"areaCodeInLocalDialing": true,
"slc": "",
"hierarchy_friendly_name": "CL1-AB-C-Grenoble (Site)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Grenoble"
},
"meta": {
"model_type": "data/DpSite",
"summary_attrs": [
{
"name": "siteName",
"title": "Site name"
},
{
"name": "siteId",
"title": "Site ID"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "title format",
"business_key": {
"hierarchy": true,
"unique": [
"siteName"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89fffaffa931cce39008b",
"href": "/api/data/HierarchyNode/5ae89fffaffa931cce39008b"
}
],
"foreign_key": [
{
"pkid": "5ae8a00aaffa931cce390408",
"path": "siteName",
"model_type": "data/BaseSiteDAT"
},
{
"pkid": "5ae89ea3affa931cce38a55c",
"path": "custName",
"model_type": "data/BaseCustomerDAT"
}
],
"self": [
{
"href": "/api/data/DpSite/5ae8a2c7affa931cce39abcc/",
"pkid": "5ae8a2c7affa931cce39abcc"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89f22affa931cce38d2f4",
"5ae89fffaffa931cce39008b",
"5ae8a2c7affa931cce39abcc"
],
"schema_version": "2.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/DpSite/5ae8a2c7affa931cce39abcc/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/DpSite/5ae8a2c7affa931cce39abcc/",
"support_async": true,
"title": "Delete"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/DpSite/5ae8a2c7affa931cce39abcc/import/",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/DpSite/5ae8a2c7affa931cce39abcc/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/DpSite/5ae8a2c7affa931cce39abcc/execute/",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/DpSite/5ae8a2c7affa931cce39abcc/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/DpSite/5ae8a2c7affa931cce39abcc/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ae8a2c7affa931cce39abcc"
},
{
"data": {
"extLen": "7",
"ext": "0",
"pkid": "5ae8a357affa931cce39ed73",
"siteName": "CL1-AB-C-Hannover",
"slcBased": false,
"emerNumber": "+494074370",
"custName": "AB_Group",
"active": true,
"areaCodeArray": [
{
"areaCode": "40",
"locNumLen": "9"
}
],
"extPrefixReq": false,
"siteId": "5",
"debug": "Valid Site created for AB_Group",
"pubNumber": "+494074370",
"areaCodeInLocalDialing": true,
"slc": "",
"hierarchy_friendly_name": "CL1-AB-C-Hannover (Site)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Hannover"
},
"meta": {
"model_type": "data/DpSite",
"summary_attrs": [
{
"name": "siteName",
"title": "Site name"
},
{
"name": "siteId",
"title": "Site ID"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "title format",
"business_key": {
"hierarchy": true,
"unique": [
"siteName"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae8a036affa931cce390dc0",
"href": "/api/data/HierarchyNode/5ae8a036affa931cce390dc0"
}
],
"foreign_key": [
{
"pkid": "5ae8a043affa931cce390fe5",
"path": "siteName",
"model_type": "data/BaseSiteDAT"
},
{
"pkid": "5ae89ea3affa931cce38a55c",
"path": "custName",
"model_type": "data/BaseCustomerDAT"
}
],
"self": [
{
"href": "/api/data/DpSite/5ae8a357affa931cce39ed66/",
"pkid": "5ae8a357affa931cce39ed66"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89f22affa931cce38d2f4",
"5ae8a036affa931cce390dc0",
"5ae8a357affa931cce39ed66"
],
"schema_version": "2.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/DpSite/5ae8a357affa931cce39ed66/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/DpSite/5ae8a357affa931cce39ed66/",
"support_async": true,
"title": "Delete"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/DpSite/5ae8a357affa931cce39ed66/import/",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/DpSite/5ae8a357affa931cce39ed66/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/DpSite/5ae8a357affa931cce39ed66/execute/",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/DpSite/5ae8a357affa931cce39ed66/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/DpSite/5ae8a357affa931cce39ed66/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ae8a357affa931cce39ed66"
}
]
}
(Show the first instance)
{
"data": {
"extLen": "7",
"ext": "0",
"debug": "Valid Site created for AB_Group",
"slcBased": false,
"emerNumber": "+494215380",
"custName": "AB_Group",
"siteName": "CL1-AB-C-Berlin",
"areaCodeArray": [
{
"areaCode": "421",
"locNumLen": "8"
}
],
"extPrefixReq": false,
"siteId": "6",
"pubNumber": "+494215380",
"active": true,
"areaCodeInLocalDialing": true,
"slc": "",
"pkid": "5ae8a387affa931cce3a035c"
},
"meta": {
"model_type": "data/DpSite",
"summary_attrs": [
{
"name": "siteName",
"title": "Site name"
},
{
"name": "siteId",
"title": "Site ID"
},
{
"name": "pubNumber",
"title": "Published number"
},
{
"name": "emerNumber",
"title": "Emergency number"
},
{
"name": "createEmerPattern",
"title": "Use DDI for emergency calls"
},
{
"name": "slc",
"title": "Site location code"
},
{
"name": "ext",
"title": "External breakout number"
},
{
"name": "extPrefixReq",
"title": "Extension prefix required?"
},
{
"name": "slcBased",
"title": "Site-Location Code (SLC) Based Dial Plan"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "title format",
"business_key": {
"hierarchy": true,
"unique": [
"siteName"
]
},
"api_version": "21.2",
"cached": false,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5ae8a04aaffa931cce3910b5",
"pkid": "5ae8a04aaffa931cce3910b5"
}
],
"foreign_key": [
{
"pkid": "5ae8a05caffa931cce3912db",
"path": "siteName",
"model_type": "data/BaseSiteDAT"
},
{
"pkid": "5ae89ea3affa931cce38a55c",
"path": "custName",
"model_type": "data/BaseCustomerDAT"
}
],
"children": [],
"self": [
{
"href": "/api/data/DpSite/5ae8a387affa931cce3a034f/",
"pkid": "5ae8a387affa931cce3a034f"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89f22affa931cce38d2f4",
"5ae8a04aaffa931cce3910b5",
"5ae8a387affa931cce3a034f"
],
"schema_version": "2.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/DpSite/5ae8a387affa931cce3a034f/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/DpSite/5ae8a387affa931cce3a034f/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/DpSite/5ae8a387affa931cce3a034f/import/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/DpSite/5ae8a387affa931cce3a034f/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/DpSite/5ae8a387affa931cce3a034f/execute/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/DpSite/5ae8a387affa931cce3a034f/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/DpSite/5ae8a387affa931cce3a034f/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "5ae8a387affa931cce3a034f"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/DpSite. | GET | /api/data/DpSite/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/DpSite as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/DpSite/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/DpSite/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/DpSite/[pkid]/import | 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 data/DpSite; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/DpSite/[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/DpSite and the JSON format can be used to import instances of data/DpSite.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Execute | POST | /api/data/DpSite/[pkid]/execute | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/DpSite/[pkid] | hierarchy=[hierarchy] | The data/DpSite instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/DpSite/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/DpSite. |