[Index]
Model ref.: device/msteamsonline/CsOnlineVoiceRoute
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": {
"NumberPattern": {
"title": "Number Pattern",
"type": "string",
"name": "NumberPattern",
"description": "A regular expression that specifies the phone numbers to which this route applies. Numbers matching this pattern will be routed according to the rest of the routing settings. For example, the default number pattern, [0-9]{10}, specifies a 10-digit number containing any digits 0 through 9."
},
"Description": {
"title": "Description",
"type": [
"string",
"null"
],
"name": "Description",
"description": "A description of what this phone route is for."
},
"Priority": {
"title": "Priority",
"type": "integer",
"name": "Priority",
"description": "A number could resolve to multiple online voice routes. The priority determines the order in which the routes will be applied if more than one route is possible."
},
"OnlinePstnUsages": {
"items": {
"target_title": "Usage",
"target": "/api/device/msteamsonline/CsOnlinePstnUsage/choices/?choice_title=Usage&field=Usage&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"choices": [],
"target_attr": "Usage",
"target_model_type": "device/msteamsonline/CsOnlinePstnUsage",
"type": "string"
},
"title": "Online PSTN Usages",
"type": [
"array",
"null"
],
"name": "OnlinePstnUsages",
"description": "A list of online PSTN usages (such as Local, Long Distance, etc.) that can be applied to this online voice route. The PSTN usage must be an existing usage."
},
"OnlinePstnGatewayList": {
"items": {
"target_title": "Identity",
"target": "/api/device/msteamsonline/CsOnlinePstnGateway/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"choices": [],
"target_attr": "Identity",
"target_model_type": "device/msteamsonline/CsOnlinePstnGateway",
"type": "string"
},
"title": "Online PSTN Gateway List",
"type": [
"array",
"null"
],
"name": "OnlinePstnGatewayList",
"description": "This parameter contains a list of online gateways associated with this online voice route. Each member of this list must be the service Identity of the online PSTN gateway. The service Identity is the fully qualified domain name (FQDN) of the pool or the IP address of the server. For example, redmondpool.litwareinc.com."
},
"Identity": {
"name": "Identity",
"title": "Name",
"required": true,
"readonly": true,
"type": "string",
"description": "The unique identity of the online voice route. "
}
},
"schema_version": "2019.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/msteamsonline/CsOnlineVoiceRoute/add/ |
|
The GUI Add form of device/msteamsonline/CsOnlineVoiceRoute 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/CsOnlineVoiceRoute | 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/CsOnlineVoiceRoute/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/msteamsonline/CsOnlineVoiceRoute/[pkid1]", "/api/device/msteamsonline/CsOnlineVoiceRoute/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/msteamsonline/CsOnlineVoiceRoute/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/msteamsonline/CsOnlineVoiceRoute/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/msteamsonline/CsOnlineVoiceRoute/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/msteamsonline/CsOnlineVoiceRoute/[pkid1]", "/api/v0/device/msteamsonline/CsOnlineVoiceRoute/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/msteamsonline/CsOnlineVoiceRoute/?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/CsOnlineVoiceRoute |
|
{"hrefs": ["/api/device/msteamsonline/CsOnlineVoiceRoute/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/msteamsonline/CsOnlineVoiceRoute |
|
{"hrefs": ["/api/device/msteamsonline/CsOnlineVoiceRoute/[pkid1]", "/api/device/msteamsonline/CsOnlineVoiceRoute/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/msteamsonline/CsOnlineVoiceRoute; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/msteamsonline/CsOnlineVoiceRoute/export/ |
|
{ "hrefs":["/api/device/msteamsonline/CsOnlineVoiceRoute/[pkid1]", "/api/device/msteamsonline/CsOnlineVoiceRoute/[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/CsOnlineVoiceRoute and the JSON format can be used to import instances of device/msteamsonline/CsOnlineVoiceRoute.
GET http://[host-proxy]/api/device/msteamsonline/CsOnlineVoiceRoute/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/msteamsonline/CsOnlineVoiceRoute | POST | /api/device/msteamsonline/CsOnlineVoiceRoute/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/CsOnlineVoiceRoute/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/CsOnlineVoiceRoute/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/CsOnlineVoiceRoute/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/msteamsonline/CsOnlineVoiceRoute/ |
|
The device/msteamsonline/CsOnlineVoiceRoute schema and all instances as JSON. |
(The list will return 0 to 3 device/msteamsonline/CsOnlineVoiceRoute instances)
{
"operations": [
"list",
"add"
],
"pagination": {
"direction": "asc",
"order_by": "Identity",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/msteamsonline/CsOnlineVoiceRoute/?skip=0&limit=3&order_by=Identity&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 7
},
"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/CsOnlineVoiceRoute/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/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/CsOnlineVoiceRoute",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/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/CsOnlineVoiceRoute/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/+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/CsOnlineVoiceRoute/+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/CsOnlineVoiceRoute/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "device/msteamsonline/CsOnlineVoiceRoute",
"model_specific_actions": [
"list",
"get",
"add",
"clone",
"update",
"remove",
"move",
"export",
"export_bulkload_template",
"bulk_update_form",
"configuration_template",
"field_display_policy",
"help",
"migration",
"transform",
"tag",
"tag_version"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "NumberPattern",
"title": "Number Pattern"
},
{
"name": "Priority",
"title": "Priority"
},
{
"name": "OnlinePstnUsages",
"title": "Online PSTN Usages"
},
{
"name": "OnlinePstnGatewayList",
"title": "Online PSTN Gateway List"
},
{
"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": "65e072a56fd4534903e1f62a",
"meta": {
"tags": [],
"cached": true,
"title": "LocalRoute",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "65e071b86fd4534903e1bf90",
"href": "/api/v0/data/MSTeamsOnline/65e071b86fd4534903e1bf90"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "65e072a56fd4534903e1f62a",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/"
}
],
"parent": [
{
"pkid": "65e06c5b6fd4534903e06868",
"href": "/api/data/HierarchyNode/65e06c5b6fd4534903e06868"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e072a56fd4534903e1f62a/?model_type=device/msteamsonline/CsOnlineVoiceRoute",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/msteamsonline/CsOnlineVoiceRoute",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"65e06c5b6fd4534903e06868",
"65e072a56fd4534903e1f62a"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "NumberPattern",
"title": "Number Pattern"
},
{
"name": "Priority",
"title": "Priority"
},
{
"name": "OnlinePstnUsages",
"title": "Online PSTN Usages"
},
{
"name": "OnlinePstnGatewayList",
"title": "Online PSTN Gateway List"
},
{
"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": {
"NumberPattern": "^(\\+1[0-9]{10})$",
"Description": null,
"hierarchy": "65e06c5b6fd4534903e06868",
"Priority": 0,
"OnlinePstnUsages": [],
"summary_device": "Connection parameters for Microsoft TeamsOnline TaurCom, TaurCom, hcs.CS-P.CS-NB.TaurCom",
"hierarchy_friendly_name": "TaurCom (Customer)",
"OnlinePstnGatewayList": [],
"Identity": "LocalRoute",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.TaurCom"
}
},
{
"pkid": "65e09ba96fd4534903e45ca7",
"meta": {
"tags": [],
"cached": true,
"title": "LocalRoute",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e098956fd4534903e3a06d",
"href": "/api/v0/data/MSTeamsOnline/65e098956fd4534903e3a06d"
}
],
"self": [
{
"pkid": "65e09ba96fd4534903e45ca7",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba96fd4534903e45ca7/"
}
],
"parent": [
{
"pkid": "65e092226fd4534903e2148a",
"href": "/api/data/HierarchyNode/65e092226fd4534903e2148a"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba96fd4534903e45ca7/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba96fd4534903e45ca7/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba96fd4534903e45ca7/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e09ba96fd4534903e45ca7/?model_type=device/msteamsonline/CsOnlineVoiceRoute",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba96fd4534903e45ca7/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba96fd4534903e45ca7/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba96fd4534903e45ca7/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba96fd4534903e45ca7/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba96fd4534903e45ca7/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba96fd4534903e45ca7/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/msteamsonline/CsOnlineVoiceRoute",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"65e092226fd4534903e2148a",
"65e09ba96fd4534903e45ca7"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "NumberPattern",
"title": "Number Pattern"
},
{
"name": "Priority",
"title": "Priority"
},
{
"name": "OnlinePstnUsages",
"title": "Online PSTN Usages"
},
{
"name": "OnlinePstnGatewayList",
"title": "Online PSTN Gateway List"
},
{
"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": {
"NumberPattern": "^(\\+1[0-9]{10})$",
"Description": null,
"hierarchy": "65e092226fd4534903e2148a",
"Priority": 0,
"OnlinePstnUsages": [],
"summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild",
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"OnlinePstnGatewayList": [],
"Identity": "LocalRoute",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
},
{
"pkid": "65e09ba86fd4534903e45c36",
"meta": {
"tags": [],
"cached": true,
"title": "Lydia_Test01",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "65e098956fd4534903e3a06d",
"href": "/api/v0/data/MSTeamsOnline/65e098956fd4534903e3a06d"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "65e09ba86fd4534903e45c36",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba86fd4534903e45c36/"
}
],
"parent": [
{
"pkid": "65e092226fd4534903e2148a",
"href": "/api/data/HierarchyNode/65e092226fd4534903e2148a"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba86fd4534903e45c36/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba86fd4534903e45c36/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba86fd4534903e45c36/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/65e09ba86fd4534903e45c36/?model_type=device/msteamsonline/CsOnlineVoiceRoute",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba86fd4534903e45c36/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba86fd4534903e45c36/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba86fd4534903e45c36/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba86fd4534903e45c36/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba86fd4534903e45c36/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e09ba86fd4534903e45c36/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/msteamsonline/CsOnlineVoiceRoute",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"65e092226fd4534903e2148a",
"65e09ba86fd4534903e45c36"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "NumberPattern",
"title": "Number Pattern"
},
{
"name": "Priority",
"title": "Priority"
},
{
"name": "OnlinePstnUsages",
"title": "Online PSTN Usages"
},
{
"name": "OnlinePstnGatewayList",
"title": "Online PSTN Gateway List"
},
{
"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": {
"NumberPattern": "^(\\+1[0-9]{10})$",
"Description": null,
"hierarchy": "65e092226fd4534903e2148a",
"Priority": 5,
"OnlinePstnUsages": [
"test"
],
"summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild",
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"OnlinePstnGatewayList": [
"lydiasbc.vossautobuild.onmicrosoft.com"
],
"Identity": "Lydia_Test01",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
}
]
}
(Show the first instance)
{
"pkid": "65e072a56fd4534903e1f62a",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "LocalRoute",
"business_key": {},
"schema_version": "",
"references": {
"parent": [
{
"pkid": "65e06c5b6fd4534903e06868",
"href": "/api/data/HierarchyNode/65e06c5b6fd4534903e06868"
}
],
"self": [
{
"pkid": "65e072a56fd4534903e1f62a",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "65e071b86fd4534903e1bf90",
"href": "/api/v0/data/MSTeamsOnline/65e071b86fd4534903e1bf90"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e072a56fd4534903e1f62a/?hierarchy=[hierarchy]&model_type=device/msteamsonline/CsOnlineVoiceRoute",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/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/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/+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/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/+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/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoute/65e072a56fd4534903e1f62a/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/msteamsonline/CsOnlineVoiceRoute",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"65e06c5b6fd4534903e06868",
"65e072a56fd4534903e1f62a"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "NumberPattern",
"title": "Number Pattern"
},
{
"name": "Priority",
"title": "Priority"
},
{
"name": "OnlinePstnUsages",
"title": "Online PSTN Usages"
},
{
"name": "OnlinePstnGatewayList",
"title": "Online PSTN Gateway List"
},
{
"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": {
"NumberPattern": "^(\\+1[0-9]{10})$",
"Description": null,
"hierarchy": "65e06c5b6fd4534903e06868",
"Priority": 0,
"OnlinePstnUsages": [],
"OnlinePstnGatewayList": [],
"Identity": "LocalRoute"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/msteamsonline/CsOnlineVoiceRoute. | GET | /api/device/msteamsonline/CsOnlineVoiceRoute/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/msteamsonline/CsOnlineVoiceRoute as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/msteamsonline/CsOnlineVoiceRoute/[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/CsOnlineVoiceRoute/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/msteamsonline/CsOnlineVoiceRoute/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/msteamsonline/CsOnlineVoiceRoute/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/msteamsonline/CsOnlineVoiceRoute | 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/CsOnlineVoiceRoute; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/msteamsonline/CsOnlineVoiceRoute/[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/CsOnlineVoiceRoute and the JSON format can be used to import instances of device/msteamsonline/CsOnlineVoiceRoute.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msteamsonline/CsOnlineVoiceRoute/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/msteamsonline/CsOnlineVoiceRoute/[pkid] | hierarchy=[hierarchy] | The device/msteamsonline/CsOnlineVoiceRoute instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/msteamsonline/CsOnlineVoiceRoute/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/msteamsonline/CsOnlineVoiceRoute. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/msteamsonline/CsOnlineVoiceRoute/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |