[Index]
Device Pool, Region & Location
Model ref.: data/DP_DP-Reg-Loc
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": {
"locationWithinVideo": {
"default": "0",
"type": "string",
"description": "Within Video Bandwidth",
"title": "Within Video Bandwidth"
},
"locationWithinAudio": {
"default": "0",
"type": "string",
"description": "Within Audio Bandwidth",
"title": "Within Audio Bandwidth"
},
"dpoolmrgl": {
"type": "string",
"description": "MRGL",
"title": "Media Resource Group List"
},
"locationBetween": {
"items": {
"type": "object",
"properties": {
"betweenAudioBW": {
"default": "Unlimited",
"choices": [
{
"value": "0",
"title": "Unlimited"
}
],
"type": "string",
"description": "Audio Bandwidth",
"title": "Audio Bandwidth"
},
"betweenVideoBW": {
"default": "None",
"choices": [
{
"value": "-1",
"title": "None"
},
{
"value": "0",
"title": "Unlimited"
}
],
"type": "string",
"description": "Video Bandwidth (kbps)",
"title": "Video Bandwidth (kbps)"
},
"betweenWeight": {
"default": "50",
"type": "string",
"description": "Weight",
"title": "Weight"
},
"betweenImmersiveBW": {
"default": "None",
"choices": [
{
"value": "-1",
"title": "None"
},
{
"value": "0",
"title": "Unlimited"
}
],
"type": "string",
"description": "Immersive Bandwidth",
"title": "Immersive Bandwidth"
},
"betweenLocationName": {
"type": "string",
"description": "Location Name",
"title": "Location Name"
}
}
},
"type": "array",
"description": "Between Location",
"title": "Links - Bandwidth Between and Adjacent Locations"
},
"srstSipPort": {
"default": "5060",
"pattern": "^[0-9]*|$",
"type": "string",
"description": "SRST SIP Port.",
"title": "SIP Port"
},
"srstPort": {
"default": "2000",
"pattern": "^[0-9]*|$",
"type": "string",
"description": "SRST Port.",
"title": "Port"
},
"dpoolLocation": {
"default": "Hub_None",
"type": "string",
"description": "Location",
"title": "Location"
},
"regionName": {
"type": "string",
"description": "Region Name",
"title": "Region Name"
},
"locationCustom": {
"default": "False",
"type": "boolean",
"description": "Add Custom Location",
"title": "Add Custom Location"
},
"srstSipIpAddress": {
"pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}|$",
"type": "string",
"description": "SRST SIP Network IP Address.",
"title": "SIP Network/IP Address"
},
"dpoolDateTime": {
"type": "string",
"description": "Date/Time Group",
"title": "Date/Time Group"
},
"locationWithinImmersive": {
"default": "0",
"type": "string",
"description": "Within Immersive Kbits",
"title": "Within Immersive Kbits"
},
"dpoollrg_ARRAY": {
"items": {
"type": "object",
"properties": {
"lrgName": {
"default": "Standard Local Route Group",
"type": "string",
"description": "Local Route Group Name",
"title": "LRG Name"
},
"rgName": {
"type": "string",
"description": "Route Group Name",
"title": "Route Group Name"
}
}
},
"type": "array",
"description": "Standard Local Route Groups",
"title": "Standard Local Route Groups"
},
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"dpoolCucmGroup": {
"type": "string",
"description": "Call Manager Group",
"title": "Call Manager Group"
},
"srstCustom": {
"type": "boolean",
"description": "Add Custom SRST Reference",
"title": "Add Custom SRST Reference"
},
"regionRelated": {
"items": {
"type": "object",
"properties": {
"relatedVideoBWImmersive": {
"default": "2147483647",
"choices": [
{
"value": "2",
"title": "Use System Default"
},
{
"value": "0",
"title": "Not Allowed"
}
],
"type": "string",
"description": "Immersive Video Bandwidth",
"title": "Maximum Session Bit Rate for Immersive Video Calls"
},
"relatedLossy": {
"default": "Use System Default",
"choices": [
{
"value": "Keep Current Setting",
"title": "Keep Current Setting"
},
{
"value": "Use System Default",
"title": "Use System Default"
},
{
"value": "Low Loss",
"title": "Low Loss"
},
{
"value": "Lossy",
"title": "Lossy"
}
],
"type": "string",
"description": "Lossy Network",
"title": "Lossy Network"
},
"relatedCodec": {
"default": "Use System Default",
"choices": [
{
"value": "Use System Default",
"title": "Use System Default"
},
{
"value": "Factory Default lossy",
"title": "Factory Default lossy"
},
{
"value": "Factory Default low loss",
"title": "Factory Default low loss"
}
],
"type": "string",
"description": "Codec Preference",
"title": "Audio Codec Preference List"
},
"relatedVideoBW": {
"default": "384",
"choices": [
{
"value": "2",
"title": "Use System Default"
},
{
"value": "0",
"title": "Not Allowed"
}
],
"type": "string",
"description": "Video Bandwidth",
"title": "Maximum Session Bit Rate for Video Calls"
},
"relatedAudioBW": {
"default": "64 kbps (G.711)",
"choices": [
{
"value": "0",
"title": "Use System Default"
},
{
"value": "7",
"title": "7 kbps (GSM-HR, G.723.1)"
},
{
"value": "8",
"title": "8 kbps (G.729)"
},
{
"value": "13",
"title": "13 kbps (GSM-FR, AMR)"
},
{
"value": "16",
"title": "16 kbps (iLBC, G.728)"
},
{
"value": "24",
"title": "24 kbps (AMR-WB)"
},
{
"value": "32",
"title": "32 kbps (iSAC, G.722.1)"
},
{
"value": "64",
"title": "64 kbps (G.711)"
},
{
"value": "128",
"title": "128 kbps (AAC-LD [LATM])"
},
{
"value": "256",
"title": "256 kbps (L16, AAC-LD)"
}
],
"type": "string",
"description": "Audio Bandwidth",
"title": "Maximum Audio Bit Rate"
},
"relatedRegionName": {
"type": "string",
"description": "Related Region Name",
"title": "Related Region Name"
}
}
},
"type": "array",
"description": "Related Region",
"title": "Related Region"
},
"srstIpAddress": {
"pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}|$",
"type": "string",
"description": "SRST Gateway IP Address.",
"title": "IP Address"
},
"srstName": {
"type": "string",
"description": "Name of new SRST Reference.",
"title": "Name"
},
"dpoolRegion": {
"default": "Default",
"type": "string",
"description": "Region",
"title": "Region"
},
"srstSecure": {
"type": "boolean",
"description": "Is SRST Secure?",
"title": "Is SRST Secure?"
},
"devicePoolCustom": {
"default": false,
"type": "boolean",
"title": "Add Device Pool"
},
"locationRelated": {
"items": {
"type": "object",
"properties": {
"rsvpSetting": {
"default": "Use System Default",
"choices": [
{
"value": "Use System Default",
"title": "Use System Default"
},
{
"value": "No Reservation",
"title": "No Reservation"
},
{
"value": "Optional(Video Desired)",
"title": "Optional(Video Desired)"
},
{
"value": "Mandatory",
"title": "Mandatory"
},
{
"value": "Mandatory(Video Desired)",
"title": "Mandatory(Video Desired)"
},
{
"value": "Allow Subscription",
"title": "Allow Subscription"
},
{
"value": "Disallow Subscription",
"title": "Disallow Subscription"
}
],
"type": "string",
"description": "RSVP Setting",
"title": "RSVP Setting"
},
"relatedLocationName": {
"type": "string",
"title": "Location Name"
}
}
},
"type": "array",
"description": "Location RSVP Settings",
"title": "Location RSVP Settings"
},
"dpoolName": {
"type": "string",
"description": "Device Pool Name",
"title": "Device Pool Name"
},
"dpoolSRST": {
"choices": [
{
"value": "Disable",
"title": "Disable"
},
{
"value": "Use Default Gateway",
"title": "Use Default Gateway"
}
],
"required": false,
"type": "string",
"description": "SRST Reference",
"title": "SRST Reference"
},
"locationName": {
"type": "string",
"description": "Location Name",
"title": "Location Name"
},
"dpoolPhysLoc": {
"type": "string",
"description": "Physical Location",
"title": "Physical Location"
},
"regionCustom": {
"default": "False",
"type": "boolean",
"title": "Add Custom Region"
}
},
"schema_version": "0.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/DP_DP-Reg-Loc/add/ |
|
The GUI Add form of data/DP_DP-Reg-Loc 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/data/DP_DP-Reg-Loc/ | 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/data/DP_DP-Reg-Loc/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/DP_DP-Reg-Loc/[pkid1]", "/api/data/DP_DP-Reg-Loc/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/DP_DP-Reg-Loc/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/DP_DP-Reg-Loc; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/DP_DP-Reg-Loc/export/ |
|
{ "hrefs":["/api/data/DP_DP-Reg-Loc/[pkid1]", "/api/data/DP_DP-Reg-Loc/[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 data/DP_DP-Reg-Loc and the JSON format can be used to import instances of data/DP_DP-Reg-Loc.
GET http://[host-proxy]/api/data/DP_DP-Reg-Loc/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/DP_DP-Reg-Loc | POST | /api/data/DP_DP-Reg-Loc/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/DP_DP-Reg-Loc/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/DP_DP-Reg-Loc/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/DP_DP-Reg-Loc/ |
|
The data/DP_DP-Reg-Loc schema and all instances as JSON. |
(The list will return 0 to 3 data/DP_DP-Reg-Loc instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"move",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "dpName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/DP_DP-Reg-Loc/?skip=0&limit=3&order_by=dpName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 2
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "0.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/data/DP_DP-Reg-Loc/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/DP_DP-Reg-Loc/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/DP_DP-Reg-Loc/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/data/DP_DP-Reg-Loc/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/DP_DP-Reg-Loc/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/data/DP_DP-Reg-Loc/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/DP_DP-Reg-Loc/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/DP_DP-Reg-Loc/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/DP_DP-Reg-Loc/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/DP_DP-Reg-Loc",
"model_specific_actions": [
"add",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"remove",
"tag",
"update"
],
"summary_attrs": [
{
"name": "dpName",
"title": "Dial Plan Name"
},
{
"name": "dpoolName",
"title": "Device Pool Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5dcecc38e186e30018eac41f",
"meta": {
"tags": [],
"cached": true,
"title": "GeoLogic-GYE-DP",
"business_key": {},
"schema_version": "0.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcecc38e186e30018eac41f",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc38e186e30018eac41f/"
}
],
"parent": [
{
"pkid": "5dcd17c256b5de00189138f9",
"href": "/api/data/HierarchyNode/5dcd17c256b5de00189138f9"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc38e186e30018eac41f/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc38e186e30018eac41f/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc38e186e30018eac41f/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc38e186e30018eac41f/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc38e186e30018eac41f/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc38e186e30018eac41f/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc38e186e30018eac41f/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/DP_DP-Reg-Loc",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcecc38e186e30018eac41f"
],
"summary_attrs": [
{
"name": "dpName",
"title": "Dial Plan Name"
},
{
"name": "dpoolName",
"title": "Device Pool Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"dpoolRegion": "Default",
"locationCustom": false,
"dpName": "GeoLogic-GYE-DP",
"pkid": "5dcecc38e186e30018eac420",
"dpoolName": "DP_{{ macro.SITENAME }}",
"dpoolmrgl": "MRGL_{{ macro.DP_CustomerName }}",
"dpoolSRST": "Disable",
"srstSipPort": "5060",
"dpoolCucmGroup": "Default",
"srstPort": "2000",
"dpoolLocation": "Hub_None",
"dpoolDateTime": "CMLocal",
"regionCustom": false,
"hierarchy_friendly_name": "CS-P (Provider)",
"dpoollrg_ARRAY": [
{
"lrgName": "Standard Local Route Group",
"rgName": "RG_SLRG_{{ macro.SITENAME }}"
}
],
"hierarchy_path": "sys.hcs.CS-P"
}
},
{
"pkid": "5dcecc384544b70019de0aa6",
"meta": {
"tags": [],
"cached": true,
"title": "GeoLogic-UIO-DP",
"business_key": {},
"schema_version": "0.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcecc384544b70019de0aa6",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc384544b70019de0aa6/"
}
],
"parent": [
{
"pkid": "5dcd17c256b5de00189138f9",
"href": "/api/data/HierarchyNode/5dcd17c256b5de00189138f9"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/data/DP_DP-Reg-Loc/5dcecc384544b70019de0aa6/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/data/DP_DP-Reg-Loc/5dcecc384544b70019de0aa6/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/data/DP_DP-Reg-Loc/5dcecc384544b70019de0aa6/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc384544b70019de0aa6/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc384544b70019de0aa6/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/data/DP_DP-Reg-Loc/5dcecc384544b70019de0aa6/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/data/DP_DP-Reg-Loc/5dcecc384544b70019de0aa6/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "data/DP_DP-Reg-Loc",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcecc384544b70019de0aa6"
],
"summary_attrs": [
{
"name": "dpName",
"title": "Dial Plan Name"
},
{
"name": "dpoolName",
"title": "Device Pool Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"dpoolRegion": "Default",
"locationCustom": false,
"dpName": "GeoLogic-UIO-DP",
"pkid": "5dcecc384544b70019de0aa7",
"dpoolName": "DP_{{ macro.SITENAME }}",
"dpoolmrgl": "MRGL_{{ macro.DP_CustomerName }}",
"dpoolSRST": "Disable",
"srstSipPort": "5060",
"dpoolCucmGroup": "Default",
"srstPort": "2000",
"dpoolLocation": "Hub_None",
"dpoolDateTime": "CMLocal",
"regionCustom": false,
"hierarchy_friendly_name": "CS-P (Provider)",
"dpoollrg_ARRAY": [
{
"lrgName": "Standard Local Route Group",
"rgName": "RG_SLRG_{{ macro.SITENAME }}"
}
],
"hierarchy_path": "sys.hcs.CS-P"
}
}
]
}
(Show the first instance)
{
"pkid": "5dcecc38e186e30018eac41f",
"meta": {
"tags": [],
"cached": false,
"title": "GeoLogic-GYE-DP",
"business_key": {},
"schema_version": "0.1",
"references": {
"parent": [
{
"pkid": "5dcd17c256b5de00189138f9",
"href": "/api/data/HierarchyNode/5dcd17c256b5de00189138f9"
}
],
"self": [
{
"pkid": "5dcecc38e186e30018eac41f",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc38e186e30018eac41f/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc38e186e30018eac41f/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc38e186e30018eac41f/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc38e186e30018eac41f/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc38e186e30018eac41f/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc38e186e30018eac41f/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc38e186e30018eac41f/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/DP_DP-Reg-Loc/5dcecc38e186e30018eac41f/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/DP_DP-Reg-Loc",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcecc38e186e30018eac41f"
],
"summary_attrs": [
{
"name": "dpName",
"title": "Dial Plan Name"
},
{
"name": "dpoolName",
"title": "Device Pool Name"
},
{
"name": "regionName",
"title": "Region Name"
},
{
"name": "locationName",
"title": "Location Name"
},
{
"name": "srstName",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"dpoolRegion": "Default",
"locationCustom": false,
"dpName": "GeoLogic-GYE-DP",
"pkid": "5dcecc38e186e30018eac420",
"dpoolName": "DP_{{ macro.SITENAME }}",
"dpoolmrgl": "MRGL_{{ macro.DP_CustomerName }}",
"dpoolSRST": "Disable",
"srstSipPort": "5060",
"dpoolCucmGroup": "Default",
"srstPort": "2000",
"dpoolLocation": "Hub_None",
"dpoolDateTime": "CMLocal",
"regionCustom": false,
"dpoollrg_ARRAY": [
{
"lrgName": "Standard Local Route Group",
"rgName": "RG_SLRG_{{ macro.SITENAME }}"
}
]
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/DP_DP-Reg-Loc. | GET | /api/data/DP_DP-Reg-Loc/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/DP_DP-Reg-Loc as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/DP_DP-Reg-Loc/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/DP_DP-Reg-Loc/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/DP_DP-Reg-Loc/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/DP_DP-Reg-Loc/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/DP_DP-Reg-Loc; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/DP_DP-Reg-Loc/[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 data/DP_DP-Reg-Loc and the JSON format can be used to import instances of data/DP_DP-Reg-Loc.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/DP_DP-Reg-Loc/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/DP_DP-Reg-Loc/[pkid]/ | hierarchy=[hierarchy] | The data/DP_DP-Reg-Loc instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/DP_DP-Reg-Loc/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/DP_DP-Reg-Loc. |