[Index]
Model ref.: view/HcsDNMgmtVIEW
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": { "site_hn": { "is_password": false, "description": "Please choose Site to Provision DNs. If site not specified, inventory will be added to the current hierarhcy node if allowed.", "title": "Site", "minItems": 0, "required": false, "displayable": false, "choices": [ { "value": " ", "title": " " } ], "readonly": false, "type": "string" }, "startNum": { "is_password": false, "description": "Starting Number for the DN Mgmt Range", "title": "Starting Extension", "minItems": 0, "pattern": "^(\\*|\\+)?[0-9]*$", "required": true, "displayable": false, "readonly": false, "type": "string" }, "endNum": { "is_password": false, "description": "Ending Number for the DN Mgmt Range", "title": "Ending Extension", "minItems": 0, "pattern": "^(\\*|\\+)?[0-9]*$", "required": false, "displayable": false, "readonly": false, "type": "string" }, "extLen": { "is_password": false, "description": "Extension Length for the Site", "title": "Extension Length", "minItems": 0, "required": false, "displayable": false, "readonly": true, "type": "string" }, "slc": { "is_password": false, "description": "Site Location Code for the Site", "title": "Site Location Code", "minItems": 0, "required": false, "displayable": false, "readonly": true, "type": "string" }, "isp": { "is_password": false, "description": "ISP for the Customer", "title": "ISP", "minItems": 0, "required": false, "displayable": false, "readonly": true, "type": "string" }, "slcBased": { "is_password": false, "description": "Site Location Code Based true or false", "title": "Site-Location Code (SLC) based", "minItems": 0, "required": false, "displayable": false, "default": "{{ data.DpCustomer.slcBased }}", "readonly": true, "type": "boolean" }, "tag": { "type": "string", "description": "Tag used for filtering INI numbers. This can be any free text to identify or comment a range of internal numbers.", "title": "Tag" }, "description": { "type": "string", "description": "Description field", "title": "Description" }, "e164number": { "pattern": "^\\+?[1-9]\\d{1,14}$", "type": "string", "description": "Number in E164 format", "title": "E164Number" }, "extra1": { "type": "string", "description": "Extra Field 1", "title": "Extra 1" }, "extra2": { "type": "string", "description": "Extra field 2", "title": "Extra 2" }, "extra3": { "type": "string", "description": "Extra field 3", "title": "Extra 3" }, "extra4": { "type": "string", "description": "Extra field 4", "title": "Extra 4" }, "extra5": { "type": "string", "description": "Extra field 5", "title": "Extra 5" }, "extra6": { "type": "string", "description": "Extra field 6", "title": "Extra 6" }, "extra7": { "type": "string", "description": "Extra field 7", "title": "Extra 7" }, "extra8": { "type": "string", "description": "Extra field 8", "title": "Extra 8" }, "extra9": { "type": "string", "description": "Extra field 9", "title": "Extra 9" } }, "schema_version": "2.5" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/view/HcsDNMgmtVIEW/add/ |
|
The GUI Add form of view/HcsDNMgmtVIEW 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/view/HcsDNMgmtVIEW | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]shows the View resource has no instance pkid, because a view model stores no instances.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of view/HcsDNMgmtVIEW; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/view/HcsDNMgmtVIEW/export/ |
|
{ "hrefs":["/api/view/HcsDNMgmtVIEW/[pkid1]", "/api/view/HcsDNMgmtVIEW/[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 view/HcsDNMgmtVIEW and the JSON format can be used to import instances of view/HcsDNMgmtVIEW.
GET http://[host-proxy]/api/view/HcsDNMgmtVIEW/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for view/HcsDNMgmtVIEW | POST | /api/view/HcsDNMgmtVIEW/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for view/HcsDNMgmtVIEW. | GET | /api/view/HcsDNMgmtVIEW/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/HcsDNMgmtVIEW as HTML |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of view/HcsDNMgmtVIEW; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/view/HcsDNMgmtVIEW/[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 view/HcsDNMgmtVIEW and the JSON format can be used to import instances of view/HcsDNMgmtVIEW.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/view/HcsDNMgmtVIEW/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/HcsDNMgmtVIEW. |