[Index]
This relation wraps the default CUCM Region element to allow for targeted network device addition.
Model ref.: relation/HcsRegionREL
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": {
"defaultCodec": {
"description": "Not valid for get and list",
"title": "Default Codec",
"minItems": 0,
"required": false,
"default": "G.711",
"maxItems": 1,
"type": "string"
},
"name": {
"description": " Enter a unique name for this region. This name can comprise up to 30 characters. Valid characters include letters, numbers, dashes, dots (periods), blanks, and underscores. \n \n \n \n Note\u00a0\u00a0\u00a0 \n Cisco recommends that you reset devices after changing a region name. \n \n \n ",
"title": "Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"maxLength": 50,
"type": "string"
},
"relatedRegions": {
"title": "Related Regions",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"relatedRegion": {
"name": "relatedRegion",
"title": "Related Region",
"minItems": 1,
"items": {
"type": [
"object",
"null"
],
"properties": {
"lossyNetwork": {
"name": "lossyNetwork",
"title": "Lossy Network",
"minItems": 0,
"required": false,
"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"
}
],
"maxItems": 1,
"type": "string"
},
"immersiveVideoBandwidth": {
"description": " The entries in this column specify the maximum immersive video bit rate (including audio) between the region that you are configuring and the region that displays in the corresponding row. ",
"title": "Immersive Video Bandwidth",
"minItems": 1,
"required": true,
"choices": [
{
"value": "-2",
"title": "Use System Default"
},
{
"value": "0",
"title": "Not Allowed"
}
],
"default": 2147483647,
"maxItems": 1,
"type": "integer",
"name": "immersiveVideoBandwidth"
},
"bandwidth": {
"description": " The entries in this column specify the maximum audio bit rate between the region that you are configuring and the region that displays in the corresponding row. ",
"title": "Bandwidth",
"minItems": 1,
"required": true,
"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, G.722)"
},
{
"value": "128",
"title": "128 kbps (AAC-LD [LATM])"
},
{
"value": "256",
"title": "256 kbps (L16, AAC-LD)"
}
],
"default": "64",
"maxItems": 1,
"type": "string",
"name": "bandwidth"
},
"videoBandwidth": {
"description": " The entries in this column specify the maximum video bit rate (including audio) between the region that you are configuring and the region that displays in the corresponding row. ",
"title": "Video Bandwidth (kbps)",
"minItems": 1,
"required": true,
"choices": [
{
"value": "-2",
"title": "Use System Default"
},
{
"value": "0",
"title": "Not Allowed"
}
],
"default": 384,
"maxItems": 1,
"type": "integer",
"name": "videoBandwidth"
},
"codecPreference": {
"description": " The entries in this column specify the audio codec preference relationship between the region that you are configuring and the region that displays in the corresponding row. ",
"title": "Codec Preference",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"name": "codecPreference"
},
"regionName": {
"target_model_type": "device/cucm/Region",
"description": " The entries in this window pane specify all existing regions, including the Default region, the region that you are configuring, and all other regions. Choose a region in this pane prior to configuring the relationships between the region that you are configuring and the chosen region. ",
"format": "uri",
"minItems": 1,
"required": true,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/Region/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Regions",
"type": "string",
"name": "regionName"
}
}
},
"required": true,
"type": "array"
}
}
},
"networkDevice": {
"type": "object",
"properties": {
"nd": {
"is_password": false,
"description": "Select the network device for which you would like to add this element.",
"title": "Network Device",
"minItems": 0,
"required": false,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"type": "string"
}
},
"title": "Network Device"
}
},
"schema_version": "2.2"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsRegionREL/add/ |
|
The GUI Add form of relation/HcsRegionREL 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/HcsRegionREL/ | 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/HcsRegionREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsRegionREL/[pkid1]", "/api/relation/HcsRegionREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsRegionREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/HcsRegionREL |
|
{"hrefs": ["/api/relation/HcsRegionREL/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/HcsRegionREL |
|
{"hrefs": ["/api/relation/HcsRegionREL/[pkid1]", "/api/relation/HcsRegionREL/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsRegionREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsRegionREL/export/ |
|
{ "hrefs":["/api/relation/HcsRegionREL/[pkid1]", "/api/relation/HcsRegionREL/[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/HcsRegionREL and the JSON format can be used to import instances of relation/HcsRegionREL.
GET http://[host-proxy]/api/relation/HcsRegionREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsRegionREL | POST | /api/relation/HcsRegionREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsRegionREL/ |
|
The relation/HcsRegionREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsRegionREL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"add",
"bulk_update",
"export",
"export_bulkload_template"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/HcsRegionREL/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 10
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.2",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/HcsRegionREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/HcsRegionREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsRegionREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/HcsRegionREL",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsRegionREL/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/HcsRegionREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/HcsRegionREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsRegionREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsRegionREL",
"model_specific_actions": [
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5dcd19b89d77dd0018b0c25a",
"meta": {
"tags": [],
"cached": true,
"title": "Cu1Si2-Region",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5dcd183c56b5de00189141b0",
"href": "/api/v0/data/CallManager/5dcd183c56b5de00189141b0"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcd19b89d77dd0018b0c25a",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/"
}
],
"parent": [
{
"pkid": "5dcd195c8192d40018f728cd",
"href": "/api/data/HierarchyNode/5dcd195c8192d40018f728cd"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd19b89d77dd0018b0c25a/?model_type=relation/HcsRegionREL",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/help",
"method": "GET",
"title": "Help"
}
},
{
"apply": {
"support_async": true,
"class": "custom",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/+apply/",
"method": "POST",
"title": "Apply"
}
},
{
"reset": {
"support_async": true,
"class": "custom",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/+reset/",
"method": "POST",
"title": "Reset"
}
}
],
"model_type": "relation/HcsRegionREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd1812e186e30018eb7023",
"5dcd195c8192d40018f728cd",
"5dcd19b89d77dd0018b0c25a"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"hierarchy_friendly_name": "LOC002 (Site)",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"name": "Cu1Si2-Region",
"relatedRegions": {
"relatedRegion": [
{
"lossyNetwork": "Use System Default",
"bandwidth": "64",
"immersiveVideoBandwidth": 2147483647,
"videoBandwidth": 384,
"codecPreference": "Use System Default",
"regionName": "Cu1Si2-Region"
},
{
"lossyNetwork": "Use System Default",
"bandwidth": "64",
"immersiveVideoBandwidth": 2147483647,
"videoBandwidth": 384,
"codecPreference": "Use System Default",
"regionName": "Default"
}
]
},
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal.LOC002"
}
},
{
"pkid": "5dcd19b88192d40018f72976",
"meta": {
"tags": [],
"cached": true,
"title": "Cu1Si3-Region",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5dcd183c56b5de00189141b0",
"href": "/api/v0/data/CallManager/5dcd183c56b5de00189141b0"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcd19b88192d40018f72976",
"href": "/api/relation/HcsRegionREL/5dcd19b88192d40018f72976/"
}
],
"parent": [
{
"pkid": "5dcd197356b5de0018915c6f",
"href": "/api/data/HierarchyNode/5dcd197356b5de0018915c6f"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/relation/HcsRegionREL/5dcd19b88192d40018f72976/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/relation/HcsRegionREL/5dcd19b88192d40018f72976/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/relation/HcsRegionREL/5dcd19b88192d40018f72976/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd19b88192d40018f72976/?model_type=relation/HcsRegionREL",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsRegionREL/5dcd19b88192d40018f72976/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/relation/HcsRegionREL/5dcd19b88192d40018f72976/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/relation/HcsRegionREL/5dcd19b88192d40018f72976/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"apply": {
"support_async": true,
"href": "/api/relation/HcsRegionREL/5dcd19b88192d40018f72976/+apply/",
"title": "Apply",
"class": "custom",
"method": "POST"
}
},
{
"reset": {
"support_async": true,
"href": "/api/relation/HcsRegionREL/5dcd19b88192d40018f72976/+reset/",
"title": "Reset",
"class": "custom",
"method": "POST"
}
}
],
"model_type": "relation/HcsRegionREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd1812e186e30018eb7023",
"5dcd197356b5de0018915c6f",
"5dcd19b88192d40018f72976"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"hierarchy_friendly_name": "LOC003 (Site)",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"name": "Cu1Si3-Region",
"relatedRegions": {
"relatedRegion": [
{
"lossyNetwork": "Use System Default",
"bandwidth": "64",
"immersiveVideoBandwidth": 2147483647,
"videoBandwidth": 384,
"codecPreference": "Use System Default",
"regionName": "Cu1Si3-Region"
},
{
"lossyNetwork": "Use System Default",
"bandwidth": "64",
"immersiveVideoBandwidth": 2147483647,
"videoBandwidth": 384,
"codecPreference": "Use System Default",
"regionName": "Default"
}
]
},
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal.LOC003"
}
},
{
"pkid": "5dcd19b8e186e30018eb80dc",
"meta": {
"tags": [],
"cached": true,
"title": "Cu1Si4-Region",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5dcd183c56b5de00189141b0",
"href": "/api/v0/data/CallManager/5dcd183c56b5de00189141b0"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcd19b8e186e30018eb80dc",
"href": "/api/relation/HcsRegionREL/5dcd19b8e186e30018eb80dc/"
}
],
"parent": [
{
"pkid": "5dcd19869d77dd0018b0c227",
"href": "/api/data/HierarchyNode/5dcd19869d77dd0018b0c227"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/relation/HcsRegionREL/5dcd19b8e186e30018eb80dc/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/relation/HcsRegionREL/5dcd19b8e186e30018eb80dc/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsRegionREL/5dcd19b8e186e30018eb80dc/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd19b8e186e30018eb80dc/?model_type=relation/HcsRegionREL",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsRegionREL/5dcd19b8e186e30018eb80dc/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsRegionREL/5dcd19b8e186e30018eb80dc/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsRegionREL/5dcd19b8e186e30018eb80dc/help",
"class": "help",
"title": "Help"
}
},
{
"apply": {
"support_async": true,
"method": "POST",
"href": "/api/relation/HcsRegionREL/5dcd19b8e186e30018eb80dc/+apply/",
"class": "custom",
"title": "Apply"
}
},
{
"reset": {
"support_async": true,
"method": "POST",
"href": "/api/relation/HcsRegionREL/5dcd19b8e186e30018eb80dc/+reset/",
"class": "custom",
"title": "Reset"
}
}
],
"model_type": "relation/HcsRegionREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd1812e186e30018eb7023",
"5dcd19869d77dd0018b0c227",
"5dcd19b8e186e30018eb80dc"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"hierarchy_friendly_name": "LOC004 (Site)",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"name": "Cu1Si4-Region",
"relatedRegions": {
"relatedRegion": [
{
"lossyNetwork": "Use System Default",
"bandwidth": "64",
"immersiveVideoBandwidth": 2147483647,
"videoBandwidth": 384,
"codecPreference": "Use System Default",
"regionName": "Cu1Si4-Region"
},
{
"lossyNetwork": "Use System Default",
"bandwidth": "64",
"immersiveVideoBandwidth": 2147483647,
"videoBandwidth": 384,
"codecPreference": "Use System Default",
"regionName": "Default"
}
]
},
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal.LOC004"
}
}
]
}
(Show the first instance)
{
"pkid": "5dcd19b89d77dd0018b0c25a",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Cu1Si2-Region",
"business_key": {},
"schema_version": "2.2",
"references": {
"device": [
{
"pkid": "5dcd183c56b5de00189141b0",
"href": "/api/v0/data/CallManager/5dcd183c56b5de00189141b0"
}
],
"self": [
{
"pkid": "5dcd19b89d77dd0018b0c25a",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/"
}
],
"children": [],
"parent": [
{
"pkid": "5dcd195c8192d40018f728cd",
"href": "/api/data/HierarchyNode/5dcd195c8192d40018f728cd"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd19b89d77dd0018b0c25a/?hierarchy=[hierarchy]&model_type=relation/HcsRegionREL",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"apply": {
"support_async": true,
"class": "custom",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/+apply/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Apply"
}
},
{
"reset": {
"support_async": true,
"class": "custom",
"href": "/api/relation/HcsRegionREL/5dcd19b89d77dd0018b0c25a/+reset/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Reset"
}
}
],
"model_type": "relation/HcsRegionREL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"name": "Cu1Si2-Region",
"relatedRegions": {
"relatedRegion": [
{
"lossyNetwork": "Use System Default",
"immersiveVideoBandwidth": 2147483647,
"bandwidth": "64",
"videoBandwidth": 384,
"codecPreference": "Use System Default",
"regionName": "Cu1Si2-Region"
},
{
"lossyNetwork": "Use System Default",
"immersiveVideoBandwidth": 2147483647,
"bandwidth": "64",
"videoBandwidth": 384,
"codecPreference": "Use System Default",
"regionName": "Default"
}
]
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsRegionREL. | GET | /api/relation/HcsRegionREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsRegionREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsRegionREL/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsRegionREL/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/HcsRegionREL/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/HcsRegionREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/HcsRegionREL | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsRegionREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsRegionREL/[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/HcsRegionREL and the JSON format can be used to import instances of relation/HcsRegionREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsRegionREL/[pkid]/ | hierarchy=[hierarchy] | The relation/HcsRegionREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsRegionREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsRegionREL. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Apply | POST | /api/relation/HcsRegionREL/[pkid]/+apply/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Reset | POST | /api/relation/HcsRegionREL/[pkid]/+reset/ | hierarchy=[hierarchy] | If payload required: |