[Index]
Model ref.: relation/HcsDpSiteShortCodeREL
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,
"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"
},
"shortCode": {
"is_password": false,
"description": "Short code number. Enter the abbreviated number to be supported by the site. This number can include wildcards (do not use spaces). Valid characters include 0 through 9, *, #, uppercase A, B, C, and D and \\+, which represents the international escape character +.",
"title": "Short Code",
"pattern": "^(\\\\\\+)?[\\[\\]!\\?\\-\\^0-9A-D\\*#X]*\\.?[\\[\\]!\\?\\-\\^0-9A-D\\*#X]*$",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 48,
"type": "string"
},
"value": {
"is_password": false,
"description": "If Short Code Type is Directory Number, the directory number to which this short code maps. If Short Code Type is Called Mask, the called mask to which this short code maps. If Short Code Type is Pre-Dot with Called Prefix, the called prefix to which this short code maps.",
"title": "Value",
"pattern": "^\\+?[0-9X*#]+$",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 16,
"type": "string"
},
"useOrigCss": {
"is_password": false,
"description": "If enabled, this short code will use the originator's calling search space to route the short code rather than an explicit CSS.",
"title": "Use Originator's Calling Search Space",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"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"
},
"type": {
"is_password": false,
"description": "The type of short code.",
"title": "Short Code Type",
"default": "calledMask",
"required": true,
"displayable": false,
"choices": [
{
"value": "dn",
"title": "Directory Number"
},
{
"value": "calledMask",
"title": "Called Mask"
},
{
"value": "preDot",
"title": "Pre-dot with Called Prefix"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
},
"schema_version": "2.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsDpSiteShortCodeREL/add/ |
|
The GUI Add form of relation/HcsDpSiteShortCodeREL 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/HcsDpSiteShortCodeREL/ | 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/HcsDpSiteShortCodeREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsDpSiteShortCodeREL/[pkid1]", "/api/relation/HcsDpSiteShortCodeREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsDpSiteShortCodeREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsDpSiteShortCodeREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsDpSiteShortCodeREL/export/ |
|
{ "hrefs":["/api/relation/HcsDpSiteShortCodeREL/[pkid1]", "/api/relation/HcsDpSiteShortCodeREL/[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/HcsDpSiteShortCodeREL and the JSON format can be used to import instances of relation/HcsDpSiteShortCodeREL.
GET http://[host-proxy]/api/relation/HcsDpSiteShortCodeREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsDpSiteShortCodeREL | POST | /api/relation/HcsDpSiteShortCodeREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsDpSiteShortCodeREL/ |
|
The relation/HcsDpSiteShortCodeREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsDpSiteShortCodeREL 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/HcsDpSiteShortCodeREL/?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.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/HcsDpSiteShortCodeREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/HcsDpSiteShortCodeREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsDpSiteShortCodeREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsDpSiteShortCodeREL/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/HcsDpSiteShortCodeREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/HcsDpSiteShortCodeREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsDpSiteShortCodeREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsDpSiteShortCodeREL",
"model_specific_actions": [
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"export"
],
"summary_attrs": [
{
"name": "siteName",
"title": "Site Name"
},
{
"name": "shortCode",
"title": "Short Code"
},
{
"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/HcsDpSiteShortCodeREL. | GET | /api/relation/HcsDpSiteShortCodeREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsDpSiteShortCodeREL as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsDpSiteShortCodeREL/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsDpSiteShortCodeREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsDpSiteShortCodeREL/[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/HcsDpSiteShortCodeREL and the JSON format can be used to import instances of relation/HcsDpSiteShortCodeREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsDpSiteShortCodeREL/[pkid]/ | hierarchy=[hierarchy] | The relation/HcsDpSiteShortCodeREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsDpSiteShortCodeREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsDpSiteShortCodeREL. |