[Index]
Model ref.: device/msteamsonline/CsTenantNetworkSite
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": {
"Description": {
"type": [
"string",
"null"
],
"name": "Description",
"title": "Description"
},
"NetworkRegionID": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTenantNetworkRegion/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"description": "NetworkRegionID is the identifier for the network region which the current network site is associating to.",
"title": "Network Region",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTenantNetworkRegion",
"type": "string",
"name": "NetworkRegionID"
},
"EnableLocationBasedRouting": {
"title": "Enable Location Based Routing",
"type": "boolean",
"name": "EnableLocationBasedRouting",
"description": "This parameter determines whether the current site is enabled for location based routing."
},
"EmergencyCallingPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTeamsEmergencyCallingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"description": "This parameter is used to assign a custom emergency calling policy to a network site.",
"title": "Emergency Calling Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsEmergencyCallingPolicy",
"type": "string",
"name": "EmergencyCallingPolicy"
},
"EmergencyCallRoutingPolicy": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsTeamsEmergencyCallRoutingPolicy/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"description": "This parameter is used to assign a custom emergency call routing policy to a network site.",
"title": "Emergency Call Routing Policy",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsEmergencyCallRoutingPolicy",
"type": "string",
"name": "EmergencyCallRoutingPolicy"
},
"NetworkRoamingPolicy": {
"title": "Network Roaming Policy",
"type": [
"string",
"null"
],
"name": "NetworkRoamingPolicy",
"description": "NetworkRoamingPolicy is the identifier for the network roaming policy to which the network site will associate to."
},
"Identity": {
"required": true,
"type": "string",
"name": "Identity",
"title": "Site Name"
}
},
"schema_version": "2019.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/msteamsonline/CsTenantNetworkSite/add/ |
|
The GUI Add form of device/msteamsonline/CsTenantNetworkSite 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/device/msteamsonline/CsTenantNetworkSite | 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/device/msteamsonline/CsTenantNetworkSite/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/msteamsonline/CsTenantNetworkSite/[pkid1]", "/api/device/msteamsonline/CsTenantNetworkSite/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/msteamsonline/CsTenantNetworkSite/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/msteamsonline/CsTenantNetworkSite/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/msteamsonline/CsTenantNetworkSite/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/msteamsonline/CsTenantNetworkSite/[pkid1]", "/api/v0/device/msteamsonline/CsTenantNetworkSite/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/msteamsonline/CsTenantNetworkSite/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/msteamsonline/CsTenantNetworkSite |
|
{"hrefs": ["/api/device/msteamsonline/CsTenantNetworkSite/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/msteamsonline/CsTenantNetworkSite |
|
{"hrefs": ["/api/device/msteamsonline/CsTenantNetworkSite/[pkid1]", "/api/device/msteamsonline/CsTenantNetworkSite/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/msteamsonline/CsTenantNetworkSite; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/msteamsonline/CsTenantNetworkSite/export/ |
|
{ "hrefs":["/api/device/msteamsonline/CsTenantNetworkSite/[pkid1]", "/api/device/msteamsonline/CsTenantNetworkSite/[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 device/msteamsonline/CsTenantNetworkSite and the JSON format can be used to import instances of device/msteamsonline/CsTenantNetworkSite.
GET http://[host-proxy]/api/device/msteamsonline/CsTenantNetworkSite/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/msteamsonline/CsTenantNetworkSite | POST | /api/device/msteamsonline/CsTenantNetworkSite/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/msteamsonline/CsTenantNetworkSite/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/msteamsonline/CsTenantNetworkSite/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/device/msteamsonline/CsTenantNetworkSite/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/msteamsonline/CsTenantNetworkSite/ |
|
The device/msteamsonline/CsTenantNetworkSite schema and all instances as JSON. |
(The list will return 0 to 3 device/msteamsonline/CsTenantNetworkSite instances)
{
"operations": [
"list",
"add"
],
"pagination": {
"direction": "asc",
"order_by": "Identity",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/msteamsonline/CsTenantNetworkSite/?skip=0&limit=3&order_by=Identity&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 8
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2019.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/device/msteamsonline/CsTenantNetworkSite/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/msteamsonline/CsTenantNetworkSite",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "device/msteamsonline/CsTenantNetworkSite",
"model_specific_actions": [
"get",
"update",
"remove",
"move",
"clone",
"export",
"export_bulkload_template",
"bulk_update_form",
"configuration_template",
"field_display_policy",
"help",
"migration",
"transform",
"tag",
"tag_version",
"add",
"list"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Site Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "EnableLocationBasedRouting",
"title": "Enable Location Based Routing"
},
{
"name": "NetworkRegionID",
"title": "Network Region"
},
{
"name": "EmergencyCallingPolicy",
"title": "Emergency Calling Policy"
},
{
"name": "EmergencyCallRoutingPolicy",
"title": "Emergency Call Routing Policy"
},
{
"name": "NetworkRoamingPolicy",
"title": "Network Roaming Policy"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "65e09d1e6fd4534903e47ca3",
"meta": {
"tags": [],
"cached": true,
"title": "CPT",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e098956fd4534903e3a06d",
"href": "/api/v0/data/MSTeamsOnline/65e098956fd4534903e3a06d"
}
],
"self": [
{
"pkid": "65e09d1e6fd4534903e47ca3",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/"
}
],
"parent": [
{
"pkid": "65e092226fd4534903e2148a",
"href": "/api/data/HierarchyNode/65e092226fd4534903e2148a"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e09d1e6fd4534903e47ca3/?model_type=device/msteamsonline/CsTenantNetworkSite",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/msteamsonline/CsTenantNetworkSite",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"65e092226fd4534903e2148a",
"65e09d1e6fd4534903e47ca3"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Site Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "EnableLocationBasedRouting",
"title": "Enable Location Based Routing"
},
{
"name": "NetworkRegionID",
"title": "Network Region"
},
{
"name": "EmergencyCallingPolicy",
"title": "Emergency Calling Policy"
},
{
"name": "EmergencyCallRoutingPolicy",
"title": "Emergency Call Routing Policy"
},
{
"name": "NetworkRoamingPolicy",
"title": "Network Roaming Policy"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"Description": null,
"hierarchy": "65e092226fd4534903e2148a",
"EnableLocationBasedRouting": false,
"EmergencyCallingPolicy": "Global",
"EmergencyCallRoutingPolicy": "Global",
"NetworkRoamingPolicy": "Global",
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild",
"Identity": "CPT",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
},
{
"pkid": "65e09d1e6fd4534903e47c8e",
"meta": {
"tags": [],
"cached": true,
"title": "GrantTestSite",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e098956fd4534903e3a06d",
"href": "/api/v0/data/MSTeamsOnline/65e098956fd4534903e3a06d"
}
],
"self": [
{
"pkid": "65e09d1e6fd4534903e47c8e",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47c8e/"
}
],
"parent": [
{
"pkid": "65e092226fd4534903e2148a",
"href": "/api/data/HierarchyNode/65e092226fd4534903e2148a"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47c8e/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47c8e/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47c8e/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e09d1e6fd4534903e47c8e/?model_type=device/msteamsonline/CsTenantNetworkSite",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47c8e/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47c8e/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47c8e/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47c8e/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47c8e/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47c8e/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/msteamsonline/CsTenantNetworkSite",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"65e092226fd4534903e2148a",
"65e09d1e6fd4534903e47c8e"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Site Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "EnableLocationBasedRouting",
"title": "Enable Location Based Routing"
},
{
"name": "NetworkRegionID",
"title": "Network Region"
},
{
"name": "EmergencyCallingPolicy",
"title": "Emergency Calling Policy"
},
{
"name": "EmergencyCallRoutingPolicy",
"title": "Emergency Call Routing Policy"
},
{
"name": "NetworkRoamingPolicy",
"title": "Network Roaming Policy"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"Description": null,
"hierarchy": "65e092226fd4534903e2148a",
"EnableLocationBasedRouting": false,
"EmergencyCallingPolicy": "Global",
"EmergencyCallRoutingPolicy": "Global",
"NetworkRoamingPolicy": "Global",
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild",
"Identity": "GrantTestSite",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
},
{
"pkid": "65e09d1d6fd4534903e47c7f",
"meta": {
"tags": [],
"cached": true,
"title": "NetworkPlace",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e098956fd4534903e3a06d",
"href": "/api/v0/data/MSTeamsOnline/65e098956fd4534903e3a06d"
}
],
"self": [
{
"pkid": "65e09d1d6fd4534903e47c7f",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1d6fd4534903e47c7f/"
}
],
"parent": [
{
"pkid": "65e092226fd4534903e2148a",
"href": "/api/data/HierarchyNode/65e092226fd4534903e2148a"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1d6fd4534903e47c7f/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1d6fd4534903e47c7f/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1d6fd4534903e47c7f/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/65e09d1d6fd4534903e47c7f/?model_type=device/msteamsonline/CsTenantNetworkSite",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1d6fd4534903e47c7f/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1d6fd4534903e47c7f/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1d6fd4534903e47c7f/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1d6fd4534903e47c7f/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1d6fd4534903e47c7f/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1d6fd4534903e47c7f/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/msteamsonline/CsTenantNetworkSite",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"65e092226fd4534903e2148a",
"65e09d1d6fd4534903e47c7f"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Site Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "EnableLocationBasedRouting",
"title": "Enable Location Based Routing"
},
{
"name": "NetworkRegionID",
"title": "Network Region"
},
{
"name": "EmergencyCallingPolicy",
"title": "Emergency Calling Policy"
},
{
"name": "EmergencyCallRoutingPolicy",
"title": "Emergency Call Routing Policy"
},
{
"name": "NetworkRoamingPolicy",
"title": "Network Roaming Policy"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"Description": "Network Site",
"hierarchy": "65e092226fd4534903e2148a",
"NetworkRegionID": "Second Region",
"EnableLocationBasedRouting": true,
"EmergencyCallingPolicy": "Global",
"EmergencyCallRoutingPolicy": "Global",
"NetworkRoamingPolicy": "Global",
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild",
"Identity": "NetworkPlace",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
}
]
}
(Show the first instance)
{
"pkid": "65e09d1e6fd4534903e47ca3",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "CPT",
"business_key": {},
"schema_version": "",
"references": {
"parent": [
{
"pkid": "65e092226fd4534903e2148a",
"href": "/api/data/HierarchyNode/65e092226fd4534903e2148a"
}
],
"self": [
{
"pkid": "65e09d1e6fd4534903e47ca3",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e098956fd4534903e3a06d",
"href": "/api/v0/data/MSTeamsOnline/65e098956fd4534903e3a06d"
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e09d1e6fd4534903e47ca3/?hierarchy=[hierarchy]&model_type=device/msteamsonline/CsTenantNetworkSite",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msteamsonline/CsTenantNetworkSite/65e09d1e6fd4534903e47ca3/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/msteamsonline/CsTenantNetworkSite",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"65e092226fd4534903e2148a",
"65e09d1e6fd4534903e47ca3"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Site Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "EnableLocationBasedRouting",
"title": "Enable Location Based Routing"
},
{
"name": "NetworkRegionID",
"title": "Network Region"
},
{
"name": "EmergencyCallingPolicy",
"title": "Emergency Calling Policy"
},
{
"name": "EmergencyCallRoutingPolicy",
"title": "Emergency Call Routing Policy"
},
{
"name": "NetworkRoamingPolicy",
"title": "Network Roaming Policy"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"Description": null,
"hierarchy": "65e092226fd4534903e2148a",
"EnableLocationBasedRouting": false,
"EmergencyCallingPolicy": "Global",
"EmergencyCallRoutingPolicy": "Global",
"NetworkRoamingPolicy": "Global",
"Identity": "CPT"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/msteamsonline/CsTenantNetworkSite. | GET | /api/device/msteamsonline/CsTenantNetworkSite/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/msteamsonline/CsTenantNetworkSite as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/msteamsonline/CsTenantNetworkSite/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/msteamsonline/CsTenantNetworkSite/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/msteamsonline/CsTenantNetworkSite/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/msteamsonline/CsTenantNetworkSite/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/msteamsonline/CsTenantNetworkSite | 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 device/msteamsonline/CsTenantNetworkSite; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/msteamsonline/CsTenantNetworkSite/[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 device/msteamsonline/CsTenantNetworkSite and the JSON format can be used to import instances of device/msteamsonline/CsTenantNetworkSite.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msteamsonline/CsTenantNetworkSite/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/msteamsonline/CsTenantNetworkSite/[pkid] | hierarchy=[hierarchy] | The device/msteamsonline/CsTenantNetworkSite instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/msteamsonline/CsTenantNetworkSite/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/msteamsonline/CsTenantNetworkSite. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/msteamsonline/CsTenantNetworkSite/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |