[Index]
This relation wraps the default CUCM Location element.
Model ref.: relation/HcsLocationREL
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": {
"betweenLocations": {
"title": "Between Locations",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"betweenLocation": {
"name": "betweenLocation",
"title": "Between Location",
"minItems": 1,
"items": {
"type": [
"object",
"null"
],
"properties": {
"locationName": {
"description": "Enter the name of the new location that you are creating. Three system locations are predefined: \n \n \n Hub_None\u2014 Hub_None is an example location that typically serves as a hub linking two or more locations. It is configured by default with unlimited intra-location bandwidth allocations for audio, video, and immersive bandwidth, but you can specify bandwidth allocations for each of these. By default, devices not assigned to other locations are assigned to Hub_None. \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n The location that is configured in a device pool takes precedence over the location configured in the device when the location in the device is set to Hub_None. If the device location is set to any other user-defined location, standard rules apply and the device parameter takes priority. \n \n \n \n \n \n Phantom\u2014Phantom location specifies unlimited audio bandwidth, unlimited video bandwidth, and unlimited immersive video bandwidth.. Specify this location to allow successful call admission control for calls across inter-cluster trunks that use the H.323 protocol or SIP trunks to certain destinations that support the earlier Location CAC feature. \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n Both Hub_None and Phantom locations do allow configuration of the associated RSVP policy setting(s). \n \n \n \n \n \n Shadow\u2014Shadow is a system location created for inter-cluster Enhanced Location CAC. In order to pass location information across clusters, the SIP ICT must be assigned to the system location Shadow. \n ",
"format": "uri",
"minItems": 1,
"required": true,
"name": "locationName",
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Location",
"title": "Location",
"choices": [],
"type": "string",
"target": "/api/device/cucm/Location/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"immersiveBandwidth": {
"description": "Enter the maximum amount of immersive video bandwidth (in kb/s) that is available for all immersive video calls on the link within this location. For video calls, the immersive video bandwidth does not include overhead. Choose among the following options: \n \n \n None\u2014The system does not allow immersive video calls between this location and other locations. Immersive video calls can, however, take place within this location. \n \n Specified bandwidth\u2014Specify an immersive video bandwidth by clicking the radio button next to the kb/s box and entering a specified immersive video bandwidth. The default value specifies 384 kb/s. \n \n Unlimited bandwidth\u2014Click the Unlimited radio button. \n ",
"title": "Immersive Bandwidth",
"minItems": 1,
"required": true,
"choices": [
{
"value": "-1",
"title": "None"
},
{
"value": "0",
"title": "Unlimited"
}
],
"default": "384",
"maxItems": 1,
"type": "integer",
"name": "immersiveBandwidth"
},
"weight": {
"description": "Enter the relative priority of this link in forming the Effective Path between any pair of Locations. The Effective Path has the least cumulative Weight of all possible paths. Valid values are 0-100. ",
"title": "Weight",
"minItems": 1,
"required": true,
"default": 50,
"maxItems": 1,
"type": "integer",
"name": "weight"
},
"videoBandwidth": {
"description": "Enter the maximum amount of video bandwidth (in kb/s) that is available for all video calls on the link between this location and other locations. For video calls, the video bandwidth does not include overhead. Choose among the following options: \n \n \n None\u2014The system does not allow video calls between this location and other locations. \n \n Specified bandwidth\u2014Specify a video bandwidth by clicking the radio button next to the kb/s box and entering a specified video bandwidth. The default value specifies 384\u00a0kb/s. \n \n Unlimited bandwidth\u2014Click the Unlimited radio button. \n ",
"title": "Video Bandwidth (kbps)",
"minItems": 1,
"required": true,
"choices": [
{
"value": "-1",
"title": "None"
},
{
"value": "0",
"title": "Unlimited"
}
],
"default": "384",
"maxItems": 1,
"type": "integer",
"name": "videoBandwidth"
},
"audioBandwidth": {
"description": "Enter the maximum amount of audio bandwidth (in kb/s) that is available for all audio calls on the link between this location and other locations. For audio calls, the audio bandwidth includes overhead. Choose between the following options: \n \n \n Unlimited bandwidth\u2014Click the Unlimited radio button. \n \n Specified bandwidth\u2014Specify a bandwidth by clicking the radio button next to the kb/s box and entering a specified bandwidth. Valid values are 1 to 2147483647. \n For purposes of location bandwidth calculations only, assume that each call stream consumes the following amount of bandwidth: \n \n \n G.711 call uses 80\u00a0kb/s. \n \n G.722 call uses 80\u00a0kb/s. \n \n G.723 call uses 24\u00a0kb/s. \n \n G.728 call uses 16\u00a0kb/s. \n \n G.729 call uses 24\u00a0kb/s. \n \n GSM call uses 29\u00a0kb/s. \n \n Wideband call uses 272\u00a0kb/s. \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n To improve audio quality, lower the bandwidth setting, so fewer active calls are allowed on this link. \n \n \n ",
"title": "blank",
"minItems": 1,
"required": true,
"choices": [
{
"value": "0",
"title": "Unlimited"
}
],
"maxItems": 1,
"type": "integer",
"name": "audioBandwidth"
}
}
},
"required": true,
"type": "array"
}
}
},
"name": {
"description": "Enter the name of the new location that you are creating. Three system locations are predefined: \n \n \n Hub_None\u2014 Hub_None is an example location that typically serves as a hub linking two or more locations. It is configured by default with unlimited intra-location bandwidth allocations for audio, video, and immersive bandwidth, but you can specify bandwidth allocations for each of these. By default, devices not assigned to other locations are assigned to Hub_None. \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n The location that is configured in a device pool takes precedence over the location configured in the device when the location in the device is set to Hub_None. If the device location is set to any other user-defined location, standard rules apply and the device parameter takes priority. \n \n \n \n \n \n Phantom\u2014Phantom location specifies unlimited audio bandwidth, unlimited video bandwidth, and unlimited immersive video bandwidth.. Specify this location to allow successful call admission control for calls across inter-cluster trunks that use the H.323 protocol or SIP trunks to certain destinations that support the earlier Location CAC feature. \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n Both Hub_None and Phantom locations do allow configuration of the associated RSVP policy setting(s). \n \n \n \n \n \n Shadow\u2014Shadow is a system location created for inter-cluster Enhanced Location CAC. In order to pass location information across clusters, the SIP ICT must be assigned to the system location Shadow. \n ",
"title": "Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"maxLength": 50,
"type": "string"
},
"relatedLocations": {
"title": "Related Locations",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"relatedLocation": {
"name": "relatedLocation",
"title": "Related Location",
"minItems": 1,
"items": {
"type": [
"object",
"null"
],
"properties": {
"locationName": {
"description": "To change the RSVP policy setting between the current location and a location that displays in this pane, choose a location in this pane.",
"format": "uri",
"minItems": 1,
"required": true,
"name": "locationName",
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Location",
"title": "Location Name",
"choices": [],
"type": "string",
"target": "/api/device/cucm/Location/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"rsvpSetting": {
"description": "\n \n To choose an RSVP policy setting between the current location and the location that is chosen in the Location pane at left, choose an RSVP setting from the drop-down list box. Choose from the following available settings:\n \n \n Use System Default\u2014The RSVP policy for the location pair matches the clusterwide RSVP policy. \n \n No Reservation\u2014No RSVP reservations can get made between any two locations. \n \n Optional (Video Desired)\u2014A call can proceed as a best-effort audio-only call if failure to obtain reservations for both audio and video streams occurs. RSVP Agent continues to attempt RSVP reservation and informs \n Cisco Unified Communications Manager if reservation succeeds. \n \n Mandatory\u2014\n Cisco Unified Communications Manager does not ring the terminating device until RSVP reservation succeeds for the audio stream and, if the call is a video call, for the video stream as well. \n \n Mandatory (Video Desired)\u2014A video call can proceed as an audio-only call if a reservation for the video stream cannot be reserved. \n \n ",
"title": "Rsvp Setting",
"minItems": 1,
"required": true,
"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"
}
],
"maxItems": 1,
"type": "string",
"name": "rsvpSetting"
}
}
},
"required": true,
"type": "array"
}
}
},
"withinImmersiveKbits": {
"description": "Enter the maximum amount of immersive video bandwidth (in kb/s) that is available for all immersive video calls on the link within this location. For video calls, the immersive video bandwidth does not include overhead. Choose among the following options: \n \n \n None\u2014The system does not allow immersive video calls between this location and other locations. Immersive video calls can, however, take place within this location. \n \n Specified bandwidth\u2014Specify an immersive video bandwidth by clicking the radio button next to the kb/s box and entering a specified immersive video bandwidth. The default value specifies 384 kb/s. \n \n Unlimited bandwidth\u2014Click the Unlimited radio button. \n ",
"title": "blank",
"minItems": 1,
"required": true,
"default": 0,
"maxItems": 1,
"type": "integer"
},
"withinAudioBandwidth": {
"description": "Enter the maximum amount of audio bandwidth (in kb/s) that is available for all audio calls on the link between this location and other locations. For audio calls, the audio bandwidth includes overhead. Choose between the following options: \n \n \n Unlimited bandwidth\u2014Click the Unlimited radio button. \n \n Specified bandwidth\u2014Specify a bandwidth by clicking the radio button next to the kb/s box and entering a specified bandwidth. Valid values are 1 to 2147483647. \n For purposes of location bandwidth calculations only, assume that each call stream consumes the following amount of bandwidth: \n \n \n G.711 call uses 80\u00a0kb/s. \n \n G.722 call uses 80\u00a0kb/s. \n \n G.723 call uses 24\u00a0kb/s. \n \n G.728 call uses 16\u00a0kb/s. \n \n G.729 call uses 24\u00a0kb/s. \n \n GSM call uses 29\u00a0kb/s. \n \n Wideband call uses 272\u00a0kb/s. \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n To improve audio quality, lower the bandwidth setting, so fewer active calls are allowed on this link. \n \n \n ",
"title": "blank",
"minItems": 1,
"required": true,
"default": 0,
"maxItems": 1,
"type": "integer"
},
"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"
},
"withinVideoBandwidth": {
"description": "Enter the maximum amount of video bandwidth (in kb/s) that is available for all video calls on the link between this location and other locations. For video calls, the video bandwidth does not include overhead. Choose among the following options: \n \n \n None\u2014The system does not allow video calls between this location and other locations. \n \n Specified bandwidth\u2014Specify a video bandwidth by clicking the radio button next to the kb/s box and entering a specified video bandwidth. The default value specifies 384\u00a0kb/s. \n \n Unlimited bandwidth\u2014Click the Unlimited radio button. \n ",
"title": "blank",
"minItems": 1,
"required": true,
"default": 0,
"maxItems": 1,
"type": "integer"
}
},
"schema_version": "2.2"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsLocationREL/add/ |
|
The GUI Add form of relation/HcsLocationREL 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/HcsLocationREL/ | 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/HcsLocationREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsLocationREL/[pkid1]", "/api/relation/HcsLocationREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsLocationREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/HcsLocationREL |
|
{"hrefs": ["/api/relation/HcsLocationREL/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/HcsLocationREL |
|
{"hrefs": ["/api/relation/HcsLocationREL/[pkid1]", "/api/relation/HcsLocationREL/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsLocationREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsLocationREL/export/ |
|
{ "hrefs":["/api/relation/HcsLocationREL/[pkid1]", "/api/relation/HcsLocationREL/[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/HcsLocationREL and the JSON format can be used to import instances of relation/HcsLocationREL.
GET http://[host-proxy]/api/relation/HcsLocationREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsLocationREL | POST | /api/relation/HcsLocationREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsLocationREL/ |
|
The relation/HcsLocationREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsLocationREL 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/HcsLocationREL/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 320
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.2",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/HcsLocationREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/HcsLocationREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsLocationREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/HcsLocationREL",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsLocationREL/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/HcsLocationREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/HcsLocationREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsLocationREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsLocationREL",
"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": "20.1.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5e8a7e77ce894e001672db96",
"meta": {
"tags": [],
"cached": true,
"title": "Cu1Si1-Location",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5e8a78f5ce894e001671eb8b",
"href": "/api/v0/data/CallManager/5e8a78f5ce894e001671eb8b"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5e8a7e77ce894e001672db96",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672db96/"
}
],
"parent": [
{
"pkid": "5e8a78cdce894e001671e1fb",
"href": "/api/data/HierarchyNode/5e8a78cdce894e001671e1fb"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672db96/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672db96/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672db96/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8a7e77ce894e001672db96/?model_type=relation/HcsLocationREL",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672db96/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672db96/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672db96/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsLocationREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8a787fce894e001671ce1b",
"5e8a78bece894e001671de53",
"5e8a78cdce894e001671e1fb",
"5e8a7e77ce894e001672db96"
],
"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": "20.1.1",
"tagged_versions": []
},
"data": {
"betweenLocations": {
"betweenLocation": [
{
"locationName": "Hub_None",
"immersiveBandwidth": 384,
"weight": 50,
"videoBandwidth": 384,
"audioBandwidth": 56
}
]
},
"name": "Cu1Si1-Location",
"relatedLocations": {
"relatedLocation": [
{
"locationName": "Cu1Si1-Location",
"rsvpSetting": "No Reservation"
}
]
},
"withinImmersiveKbits": 0,
"withinAudioBandwidth": 0,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"withinVideoBandwidth": 0,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "5e8a8047ce894e0016730ad2",
"meta": {
"tags": [],
"cached": true,
"title": "Cu1Si1-Location",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5e8a7923ce894e001671f5a6",
"href": "/api/v0/data/CallManager/5e8a7923ce894e001671f5a6"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5e8a8047ce894e0016730ad2",
"href": "/api/relation/HcsLocationREL/5e8a8047ce894e0016730ad2/"
}
],
"parent": [
{
"pkid": "5e8a78cdce894e001671e1fb",
"href": "/api/data/HierarchyNode/5e8a78cdce894e001671e1fb"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/relation/HcsLocationREL/5e8a8047ce894e0016730ad2/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/relation/HcsLocationREL/5e8a8047ce894e0016730ad2/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/relation/HcsLocationREL/5e8a8047ce894e0016730ad2/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8a8047ce894e0016730ad2/?model_type=relation/HcsLocationREL",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsLocationREL/5e8a8047ce894e0016730ad2/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/relation/HcsLocationREL/5e8a8047ce894e0016730ad2/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/relation/HcsLocationREL/5e8a8047ce894e0016730ad2/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "relation/HcsLocationREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8a787fce894e001671ce1b",
"5e8a78bece894e001671de53",
"5e8a78cdce894e001671e1fb",
"5e8a8047ce894e0016730ad2"
],
"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": "20.1.1",
"tagged_versions": []
},
"data": {
"betweenLocations": {
"betweenLocation": [
{
"locationName": "Hub_None",
"immersiveBandwidth": 384,
"weight": 50,
"videoBandwidth": 384,
"audioBandwidth": 56
}
]
},
"name": "Cu1Si1-Location",
"relatedLocations": {
"relatedLocation": [
{
"locationName": "Cu1Si1-Location",
"rsvpSetting": "No Reservation"
}
]
},
"withinImmersiveKbits": 0,
"withinAudioBandwidth": 0,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Dedicated CUCM, 192.168.100.16, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"withinVideoBandwidth": 0,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "5e8a7e77ce894e001672dba3",
"meta": {
"tags": [],
"cached": true,
"title": "Cu1Si10-Location",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5e8a78f5ce894e001671eb8b",
"href": "/api/v0/data/CallManager/5e8a78f5ce894e001671eb8b"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5e8a7e77ce894e001672dba3",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672dba3/"
}
],
"parent": [
{
"pkid": "5e8a78cdce894e001671e1fb",
"href": "/api/data/HierarchyNode/5e8a78cdce894e001671e1fb"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672dba3/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672dba3/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672dba3/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8a7e77ce894e001672dba3/?model_type=relation/HcsLocationREL",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672dba3/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672dba3/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672dba3/help",
"class": "help",
"title": "Help"
}
}
],
"model_type": "relation/HcsLocationREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8a787fce894e001671ce1b",
"5e8a78bece894e001671de53",
"5e8a78cdce894e001671e1fb",
"5e8a7e77ce894e001672dba3"
],
"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": "20.1.1",
"tagged_versions": []
},
"data": {
"betweenLocations": {
"betweenLocation": [
{
"locationName": "Hub_None",
"immersiveBandwidth": 384,
"weight": 50,
"videoBandwidth": 384,
"audioBandwidth": 56
}
]
},
"name": "Cu1Si10-Location",
"relatedLocations": {
"relatedLocation": [
{
"locationName": "Cu1Si10-Location",
"rsvpSetting": "No Reservation"
}
]
},
"withinImmersiveKbits": 0,
"withinAudioBandwidth": 0,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"withinVideoBandwidth": 0,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "5e8a7e77ce894e001672db96",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Cu1Si1-Location",
"business_key": {},
"schema_version": "2.2",
"references": {
"device": [
{
"pkid": "5e8a78f5ce894e001671eb8b",
"href": "/api/v0/data/CallManager/5e8a78f5ce894e001671eb8b"
}
],
"self": [
{
"pkid": "5e8a7e77ce894e001672db96",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672db96/"
}
],
"children": [],
"parent": [
{
"pkid": "5e8a78cdce894e001671e1fb",
"href": "/api/data/HierarchyNode/5e8a78cdce894e001671e1fb"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672db96/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672db96/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672db96/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8a7e77ce894e001672db96/?hierarchy=[hierarchy]&model_type=relation/HcsLocationREL",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672db96/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672db96/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsLocationREL/5e8a7e77ce894e001672db96/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsLocationREL",
"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": "20.1.1",
"tagged_versions": []
},
"data": {
"betweenLocations": {
"betweenLocation": [
{
"locationName": "Hub_None",
"immersiveBandwidth": 384,
"videoBandwidth": 384,
"weight": 50,
"audioBandwidth": 56
}
]
},
"name": "Cu1Si1-Location",
"relatedLocations": {
"relatedLocation": [
{
"locationName": "Cu1Si1-Location",
"rsvpSetting": "No Reservation"
}
]
},
"withinImmersiveKbits": 0,
"withinAudioBandwidth": 0,
"shadow": [],
"withinVideoBandwidth": 0
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsLocationREL. | GET | /api/relation/HcsLocationREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsLocationREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsLocationREL/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsLocationREL/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/HcsLocationREL/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/HcsLocationREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/HcsLocationREL | 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/HcsLocationREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsLocationREL/[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/HcsLocationREL and the JSON format can be used to import instances of relation/HcsLocationREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsLocationREL/[pkid]/ | hierarchy=[hierarchy] | The relation/HcsLocationREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsLocationREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsLocationREL. |