[Index]
Model ref.: relation/HcsDpManageCustomerREL
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": {
"custName": {
"title": "Customer Name",
"description": "The name of the customer.",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": true,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/BaseCustomerDAT/choices/?field=CustomerName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "CustomerName",
"default": "{{ macro.HcsDpCustomerName }}",
"target_model_type": "data/BaseCustomerDAT",
"choices": []
},
"ext": {
"title": "External breakout number",
"description": "Default external breakout number for this customer.",
"type": "string",
"maxLength": 1,
"required": true,
"readonly": false,
"is_password": false,
"displayable": false,
"pattern": "^[0-9]*$",
"default": "9"
},
"slcBased": {
"title": "Site-Location Code (SLC) Based Dial Plan",
"description": "Indicates whether or not Site Location Code is required for this customer.",
"type": "boolean",
"required": true,
"readonly": false,
"is_password": false,
"displayable": false,
"default": "false"
},
"isCSSEnable": {
"title": "Enable CSS filtering",
"description": "Indicates enabling or disabling the CSS filtering in the Day 2 templates.",
"type": "boolean",
"required": true,
"readonly": false,
"is_password": false,
"displayable": false,
"default": "false"
},
"ispReq": {
"title": "Inter-Site Prefix (ISP) Required",
"description": "Indicates whether or not ISP is required for inter-site dialing.",
"type": "boolean",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"default": "false"
},
"isp": {
"title": "Inter-Site Prefix",
"description": "Inter-site prefix if ISP required for inter-site dialing.",
"type": "string",
"maxLength": 1,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"pattern": "^$|^[0-9]+$"
},
"ispInSlc": {
"title": "ISP included in SLC",
"description": "If ISP is required, indicates whether ISP is included in SLC.",
"type": "boolean",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"default": "false"
},
"ispInVMID": {
"title": "ISP included in Voice Mail ID",
"description": "If ISP is required, indicates whether ISP is included in the VMID.",
"type": "boolean",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"default": "false"
},
"extPrefixInUse": {
"title": "Use extension prefix?",
"description": "If selected, an extension prefix can be specified which can be used on sites for this customer.",
"type": "boolean",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"default": "false"
},
"extPrefix": {
"title": "Extension prefix",
"description": "Specify an optional extension prefix for this customer. Each site can select whether this extension prefix will be required.",
"type": "string",
"maxLength": 1,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"pattern": "^$|^[0-9#*]+$"
},
"dpType": {
"title": "Dial Plan Type",
"description": "This is an internal field to store the DP type.",
"type": "string",
"maxLength": 1024,
"required": true,
"readonly": false,
"is_password": false,
"displayable": false,
"default": "Unknown"
},
"customerId": {
"title": "Customer ID",
"description": "Unique ID for this customer.",
"type": "string",
"maxLength": 1024,
"required": true,
"readonly": true,
"is_password": false,
"displayable": false,
"default": "{{ macro.HcsDpCustomerId }}"
},
"debug": {
"title": "Debug Info",
"description": "This is an internal field to store debug info.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"default": "** Bogus DP customer **"
},
"shadow": {
"title": "Shadow",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"maxLength": 1024,
"required": true,
"readonly": false,
"is_password": false,
"displayable": false
}
}
},
"maxItems": 1
}
},
"schema_version": "2.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsDpManageCustomerREL/add/ |
|
The GUI Add form of relation/HcsDpManageCustomerREL as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/relation/HcsDpManageCustomerREL | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/HcsDpManageCustomerREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsDpManageCustomerREL/[pkid1]", "/api/relation/HcsDpManageCustomerREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsDpManageCustomerREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsDpManageCustomerREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsDpManageCustomerREL/export/ |
|
{ "hrefs":["/api/relation/HcsDpManageCustomerREL/[pkid1]", "/api/relation/HcsDpManageCustomerREL/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of relation/HcsDpManageCustomerREL and the JSON format can be used to import instances of relation/HcsDpManageCustomerREL.
GET http://[host-proxy]/api/relation/HcsDpManageCustomerREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsDpManageCustomerREL | POST | /api/relation/HcsDpManageCustomerREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsDpManageCustomerREL/ |
|
The relation/HcsDpManageCustomerREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsDpManageCustomerREL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 1,
"total_limit": null,
"order_by": "custName",
"direction": "asc",
"current": "/api/relation/HcsDpManageCustomerREL/?skip=0&limit=3&order_by=custName&direction=asc&traversal=down"
},
"operations": [
"list",
"help",
"field_display_policy",
"get",
"configuration_template",
"update",
"bulk_update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/HcsDpManageCustomerREL",
"summary_attrs": [
{
"name": "custName",
"title": "Customer Name"
},
{
"name": "customerId",
"title": "Customer ID"
},
{
"name": "dpType",
"title": "Dial Plan Type"
},
{
"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": [],
"self": [
{
"href": "/api/relation/HcsDpManageCustomerREL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"list",
"help",
"get",
"update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"schema_version": "2.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/HcsDpManageCustomerREL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsDpManageCustomerREL/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/HcsDpManageCustomerREL/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/relation/HcsDpManageCustomerREL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/HcsDpManageCustomerREL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsDpManageCustomerREL/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"extPrefixInUse": false,
"ispInVMID": false,
"ispReq": false,
"isp": "",
"ispInSlc": false,
"slcBased": false,
"custName": "AB_Group",
"debug": "DP Type 4",
"ext": "9",
"isCSSEnable": true,
"extPrefix": "",
"customerId": "1",
"dpType": "Type_4",
"pkid": "5df0b67ace894e001275ae2a",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "relation/HcsDpManageCustomerREL",
"summary_attrs": [
{
"name": "custName",
"title": "Customer Name"
},
{
"name": "customerId",
"title": "Customer ID"
},
{
"name": "dpType",
"title": "Dial Plan Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "title format",
"business_key": {
"hierarchy": false,
"unique": [
"custName"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5df0b66bce894e001275a913",
"href": "/api/data/HierarchyNode/5df0b66bce894e001275a913"
}
],
"foreign_key": [
{
"pkid": "5df0b66cce894e001275a94c",
"path": "custName",
"model_type": "data/BaseCustomerDAT"
}
],
"self": [
{
"href": "/api/relation/HcsDpManageCustomerREL/5df0b67ace894e001275ae27/",
"pkid": "5df0b67ace894e001275ae27"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0b67ace894e001275ae27"
],
"schema_version": "2.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsDpManageCustomerREL/5df0b67ace894e001275ae27/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsDpManageCustomerREL/5df0b67ace894e001275ae27/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsDpManageCustomerREL/5df0b67ace894e001275ae27/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsDpManageCustomerREL/5df0b67ace894e001275ae27/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsDpManageCustomerREL/5df0b67ace894e001275ae27/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5df0b67ace894e001275ae27"
}
]
}
(Show the first instance)
{
"data": {
"extPrefixInUse": false,
"ispInVMID": false,
"ispReq": false,
"isp": "",
"ispInSlc": false,
"slcBased": false,
"custName": "AB_Group",
"debug": "DP Type 4",
"ext": "9",
"isCSSEnable": true,
"extPrefix": "",
"customerId": "1",
"dpType": "Type_4",
"shadow": []
},
"meta": {
"model_type": "relation/HcsDpManageCustomerREL",
"summary_attrs": [
{
"name": "custName",
"title": "Customer Name"
},
{
"name": "customerId",
"title": "Customer ID"
},
{
"name": "dpType",
"title": "Dial Plan Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "AB_Group",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"children": [],
"parent": [
{
"pkid": "5df0b66bce894e001275a913",
"href": "/api/data/HierarchyNode/5df0b66bce894e001275a913"
}
],
"self": [
{
"href": "/api/relation/HcsDpManageCustomerREL/5df0b67ace894e001275ae27/",
"pkid": "5df0b67ace894e001275ae27"
}
]
},
"schema_version": "2.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsDpManageCustomerREL/5df0b67ace894e001275ae27/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsDpManageCustomerREL/5df0b67ace894e001275ae27/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsDpManageCustomerREL/5df0b67ace894e001275ae27/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsDpManageCustomerREL/5df0b67ace894e001275ae27/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsDpManageCustomerREL/5df0b67ace894e001275ae27/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "5df0b67ace894e001275ae27"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsDpManageCustomerREL. | GET | /api/relation/HcsDpManageCustomerREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsDpManageCustomerREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsDpManageCustomerREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsDpManageCustomerREL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsDpManageCustomerREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsDpManageCustomerREL/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of relation/HcsDpManageCustomerREL and the JSON format can be used to import instances of relation/HcsDpManageCustomerREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsDpManageCustomerREL/[pkid] | hierarchy=[hierarchy] | The relation/HcsDpManageCustomerREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsDpManageCustomerREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsDpManageCustomerREL. |