[Index]
Model ref.: device/msteamsonline/CsOnlineVoiceRoutingPolicy
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": {
"RouteType": {
"readonly": true,
"title": "Route Type",
"type": "string",
"name": "RouteType",
"description": ""
},
"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 or Long Distance) that can be applied to this online voice routing policy. The online PSTN usage must be an existing usage."
},
"Description": {
"title": "Description",
"type": [
"string",
"null"
],
"name": "Description",
"description": "Enables administrators to provide explanatory text to accompany an online voice routing policy. For example, the Description might include information about the users the policy should be assigned to."
},
"Identity": {
"name": "Identity",
"title": "Name",
"required": true,
"readonly": true,
"type": "string",
"description": "Unique identifier assigned to the policy when it was created. Online voice routing policies can be assigned at the global scope or the per-user scope."
}
},
"schema_version": "2019.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/add/ |
|
The GUI Add form of device/msteamsonline/CsOnlineVoiceRoutingPolicy 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/CsOnlineVoiceRoutingPolicy | 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/CsOnlineVoiceRoutingPolicy/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/[pkid1]", "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/msteamsonline/CsOnlineVoiceRoutingPolicy/[pkid1]", "/api/v0/device/msteamsonline/CsOnlineVoiceRoutingPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/?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/CsOnlineVoiceRoutingPolicy |
|
{"hrefs": ["/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/msteamsonline/CsOnlineVoiceRoutingPolicy |
|
{"hrefs": ["/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/[pkid1]", "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/msteamsonline/CsOnlineVoiceRoutingPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/export/ |
|
{ "hrefs":["/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/[pkid1]", "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/[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/CsOnlineVoiceRoutingPolicy and the JSON format can be used to import instances of device/msteamsonline/CsOnlineVoiceRoutingPolicy.
GET http://[host-proxy]/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/msteamsonline/CsOnlineVoiceRoutingPolicy | POST | /api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/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/CsOnlineVoiceRoutingPolicy/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/CsOnlineVoiceRoutingPolicy/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/CsOnlineVoiceRoutingPolicy/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/ |
|
The device/msteamsonline/CsOnlineVoiceRoutingPolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/msteamsonline/CsOnlineVoiceRoutingPolicy instances)
{
"operations": [
"list",
"add"
],
"pagination": {
"direction": "asc",
"order_by": "Identity",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/?skip=0&limit=3&order_by=Identity&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 6
},
"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/CsOnlineVoiceRoutingPolicy/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/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/CsOnlineVoiceRoutingPolicy",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/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/CsOnlineVoiceRoutingPolicy/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/+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/CsOnlineVoiceRoutingPolicy/+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/CsOnlineVoiceRoutingPolicy/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "device/msteamsonline/CsOnlineVoiceRoutingPolicy",
"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": "RouteType",
"title": "Route Type"
},
{
"name": "OnlinePstnUsages",
"title": "Online PSTN Usages"
},
{
"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": "655efc9240d96fe47c24aac9",
"meta": {
"tags": [],
"cached": true,
"title": "Global",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "655efaa040d96fe47c23f48e",
"href": "/api/v0/data/MSTeamsOnline/655efaa040d96fe47c23f48e"
}
],
"self": [
{
"pkid": "655efc9240d96fe47c24aac9",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/"
}
],
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/655efc9240d96fe47c24aac9/?model_type=device/msteamsonline/CsOnlineVoiceRoutingPolicy",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/msteamsonline/CsOnlineVoiceRoutingPolicy",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efc9240d96fe47c24aac9"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "RouteType",
"title": "Route Type"
},
{
"name": "OnlinePstnUsages",
"title": "Online PSTN Usages"
},
{
"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": "655ef9d340d96fe47c238be3",
"OnlinePstnUsages": [],
"RouteType": "BYOT",
"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": "Global",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
},
{
"pkid": "655efc9440d96fe47c24abe3",
"meta": {
"tags": [],
"cached": true,
"title": "International",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "655efaa040d96fe47c23f48e",
"href": "/api/v0/data/MSTeamsOnline/655efaa040d96fe47c23f48e"
}
],
"self": [
{
"pkid": "655efc9440d96fe47c24abe3",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9440d96fe47c24abe3/"
}
],
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9440d96fe47c24abe3/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9440d96fe47c24abe3/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9440d96fe47c24abe3/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/655efc9440d96fe47c24abe3/?model_type=device/msteamsonline/CsOnlineVoiceRoutingPolicy",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9440d96fe47c24abe3/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9440d96fe47c24abe3/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9440d96fe47c24abe3/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9440d96fe47c24abe3/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9440d96fe47c24abe3/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9440d96fe47c24abe3/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/msteamsonline/CsOnlineVoiceRoutingPolicy",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efc9440d96fe47c24abe3"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "RouteType",
"title": "Route Type"
},
{
"name": "OnlinePstnUsages",
"title": "Online PSTN Usages"
},
{
"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": "655ef9d340d96fe47c238be3",
"OnlinePstnUsages": [],
"RouteType": "BYOT",
"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": "International",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
},
{
"pkid": "655efc9340d96fe47c24ab60",
"meta": {
"tags": [],
"cached": true,
"title": "RVD VRP1",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "655efaa040d96fe47c23f48e",
"href": "/api/v0/data/MSTeamsOnline/655efaa040d96fe47c23f48e"
}
],
"self": [
{
"pkid": "655efc9340d96fe47c24ab60",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9340d96fe47c24ab60/"
}
],
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9340d96fe47c24ab60/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9340d96fe47c24ab60/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9340d96fe47c24ab60/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/655efc9340d96fe47c24ab60/?model_type=device/msteamsonline/CsOnlineVoiceRoutingPolicy",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9340d96fe47c24ab60/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9340d96fe47c24ab60/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9340d96fe47c24ab60/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9340d96fe47c24ab60/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9340d96fe47c24ab60/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9340d96fe47c24ab60/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/msteamsonline/CsOnlineVoiceRoutingPolicy",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efc9340d96fe47c24ab60"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "RouteType",
"title": "Route Type"
},
{
"name": "OnlinePstnUsages",
"title": "Online PSTN Usages"
},
{
"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": "RVD VRP1",
"hierarchy": "655ef9d340d96fe47c238be3",
"OnlinePstnUsages": [],
"RouteType": "BYOT",
"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": "RVD VRP1",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
}
]
}
(Show the first instance)
{
"pkid": "655efc9240d96fe47c24aac9",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Global",
"business_key": {},
"schema_version": "",
"references": {
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"self": [
{
"pkid": "655efc9240d96fe47c24aac9",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "655efaa040d96fe47c23f48e",
"href": "/api/v0/data/MSTeamsOnline/655efaa040d96fe47c23f48e"
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/655efc9240d96fe47c24aac9/?hierarchy=[hierarchy]&model_type=device/msteamsonline/CsOnlineVoiceRoutingPolicy",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/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/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/+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/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/+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/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/655efc9240d96fe47c24aac9/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/msteamsonline/CsOnlineVoiceRoutingPolicy",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efc9240d96fe47c24aac9"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "RouteType",
"title": "Route Type"
},
{
"name": "OnlinePstnUsages",
"title": "Online PSTN Usages"
},
{
"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": {
"hierarchy": "655ef9d340d96fe47c238be3",
"RouteType": "BYOT",
"OnlinePstnUsages": [],
"Description": null,
"Identity": "Global"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/msteamsonline/CsOnlineVoiceRoutingPolicy. | GET | /api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/msteamsonline/CsOnlineVoiceRoutingPolicy as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/[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/CsOnlineVoiceRoutingPolicy/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/msteamsonline/CsOnlineVoiceRoutingPolicy | 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/CsOnlineVoiceRoutingPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/[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/CsOnlineVoiceRoutingPolicy and the JSON format can be used to import instances of device/msteamsonline/CsOnlineVoiceRoutingPolicy.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/[pkid] | hierarchy=[hierarchy] | The device/msteamsonline/CsOnlineVoiceRoutingPolicy instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/msteamsonline/CsOnlineVoiceRoutingPolicy. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/msteamsonline/CsOnlineVoiceRoutingPolicy/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |