[Index]
Model ref.: relation/HcsDpDnRangeREL
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": {
"is_password": false,
"target_model_type": "data/BaseCustomerDAT",
"target": "/api/data/BaseCustomerDAT/choices/?field=CustomerName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": true,
"displayable": false,
"choices": [],
"target_attr": "CustomerName",
"readonly": false,
"maxLength": 1024,
"title": "Customer Name",
"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"
},
"dnRangeMask": {
"is_password": false,
"description": "Directory Number Range mask. Number of wildcard 'X' characters to append to the specified directory number range. For example, 2 would indicate XX. A range of 0 indicates that no mask will be used and the Directory Number Range will be an explicit directory number that should be internally routable.",
"title": "Directory Number Range Mask",
"pattern": "^([0-9]|[1][01])$",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 2,
"type": "string"
},
"dnRange": {
"is_password": false,
"description": "DN Range. String composed of one of more digits in the range 0 to 9 and must be unique within the customer network. The string can also begin with \\+ which represents the international escape character + or *. Used to group a set of directory numbers, to a site that has similar characteristics. The length may be determined on a site-by-site bases. The DN Range should not 1) have a first portion that matches an existing, shorter DN Range or site location code or 2) match the first portion of an existing, longer DN Range or site location code.",
"title": "Directory Number Range",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 30,
"type": "string"
}
},
"schema_version": "2.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsDpDnRangeREL/add/ |
|
The GUI Add form of relation/HcsDpDnRangeREL 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/HcsDpDnRangeREL/ | 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/HcsDpDnRangeREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsDpDnRangeREL/[pkid1]", "/api/relation/HcsDpDnRangeREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsDpDnRangeREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsDpDnRangeREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsDpDnRangeREL/export/ |
|
{ "hrefs":["/api/relation/HcsDpDnRangeREL/[pkid1]", "/api/relation/HcsDpDnRangeREL/[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/HcsDpDnRangeREL and the JSON format can be used to import instances of relation/HcsDpDnRangeREL.
GET http://[host-proxy]/api/relation/HcsDpDnRangeREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsDpDnRangeREL | POST | /api/relation/HcsDpDnRangeREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsDpDnRangeREL/ |
|
The relation/HcsDpDnRangeREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsDpDnRangeREL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "custName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/HcsDpDnRangeREL/?skip=0&limit=3&order_by=custName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/HcsDpDnRangeREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/HcsDpDnRangeREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsDpDnRangeREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsDpDnRangeREL/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/HcsDpDnRangeREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/HcsDpDnRangeREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsDpDnRangeREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsDpDnRangeREL",
"model_specific_actions": [
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"export"
],
"summary_attrs": [
{
"name": "custName",
"title": "Customer Name"
},
{
"name": "dnRange",
"title": "Directory Number Range"
},
{
"name": "dnRangeMask",
"title": "Directory Number Range Mask"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsDpDnRangeREL. | GET | /api/relation/HcsDpDnRangeREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsDpDnRangeREL as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsDpDnRangeREL/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsDpDnRangeREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsDpDnRangeREL/[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/HcsDpDnRangeREL and the JSON format can be used to import instances of relation/HcsDpDnRangeREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsDpDnRangeREL/[pkid]/ | hierarchy=[hierarchy] | The relation/HcsDpDnRangeREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsDpDnRangeREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsDpDnRangeREL. |