[Index]
Model ref.: relation/HcsDpManageSiteREL
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": {
"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"
},
"siteName": {
"is_password": false,
"target": "/api/data/BaseSiteDAT/choices/?field=SiteName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"default": "{{ macro.HcsDpSiteName }}",
"title": "Site name",
"required": true,
"displayable": false,
"choices": [],
"target_attr": "SiteName",
"readonly": false,
"maxLength": 1024,
"target_model_type": "data/BaseSiteDAT",
"type": "string"
},
"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"
},
"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"
},
"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"
},
"custName": {
"is_password": false,
"description": "Specify the customer that owns this site",
"format": "uri",
"default": "{{ macro.HcsDpCustomerName }}",
"title": "Customer",
"required": false,
"displayable": false,
"choices": [],
"target_attr": "CustomerName",
"readonly": false,
"maxLength": 1024,
"target_model_type": "data/BaseCustomerDAT",
"type": "string",
"target": "/api/data/BaseCustomerDAT/choices/?field=CustomerName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"shadow": {
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"type": "array",
"maxItems": 1,
"title": "Shadow"
},
"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"
},
"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"
}
},
"schema_version": "2.2"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsDpManageSiteREL/add/ |
|
The GUI Add form of relation/HcsDpManageSiteREL 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/HcsDpManageSiteREL/ | 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/HcsDpManageSiteREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsDpManageSiteREL/[pkid1]", "/api/relation/HcsDpManageSiteREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsDpManageSiteREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsDpManageSiteREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsDpManageSiteREL/export/ |
|
{ "hrefs":["/api/relation/HcsDpManageSiteREL/[pkid1]", "/api/relation/HcsDpManageSiteREL/[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/HcsDpManageSiteREL and the JSON format can be used to import instances of relation/HcsDpManageSiteREL.
GET http://[host-proxy]/api/relation/HcsDpManageSiteREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsDpManageSiteREL | POST | /api/relation/HcsDpManageSiteREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsDpManageSiteREL/ |
|
The relation/HcsDpManageSiteREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsDpManageSiteREL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "siteName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/HcsDpManageSiteREL/?skip=0&limit=3&order_by=siteName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.2",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/HcsDpManageSiteREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/HcsDpManageSiteREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsDpManageSiteREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsDpManageSiteREL/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/HcsDpManageSiteREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/HcsDpManageSiteREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsDpManageSiteREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsDpManageSiteREL",
"model_specific_actions": [
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"export"
],
"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"
},
{
"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 relation/HcsDpManageSiteREL. | GET | /api/relation/HcsDpManageSiteREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsDpManageSiteREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsDpManageSiteREL/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsDpManageSiteREL/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsDpManageSiteREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsDpManageSiteREL/[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/HcsDpManageSiteREL and the JSON format can be used to import instances of relation/HcsDpManageSiteREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsDpManageSiteREL/[pkid]/ | hierarchy=[hierarchy] | The relation/HcsDpManageSiteREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsDpManageSiteREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsDpManageSiteREL. |