[Index]
Model ref.: device/msteamsonline/CsOnlinePstnGateway
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": {
"BypassMode": {
"name": "BypassMode",
"description": "Possible values are \"None\", \"Always\" and \"OnlyForLocalUsers\". By setting \"Always\" mode you indicate that your network is fully routable. If a user usually in site \"Seattle\", travels to site \"Tallinn\" and tries to use SBC located in Seattle we will try to deliver the traffic to Seattle assuming that there is connection between Tallinn and Seattle offices. With \"OnlyForLocaUsers\" you indicate that there is no direct connection between sites. In example above, the traffic will not be send directly from Tallinn to Seattle.",
"type": [
"string",
"null"
],
"title": "Bypass Mode",
"choices": [
{
"title": "None",
"value": "None"
},
{
"title": "Always",
"value": "Always"
},
{
"title": "OnlyForLocalUsers",
"value": "OnlyForLocalUsers"
}
]
},
"Description": {
"name": "Description",
"type": [
"string",
"null"
],
"title": "Description"
},
"Enabled": {
"name": "Enabled",
"description": "Used to enable this SBC for outbound calls. Can be used to temporarily remove the SBC from service while it is being updated or during maintenance. Note if the parameter is not set the SBC will be created as disabled (default value -Enabled $false).",
"type": "boolean",
"title": "Enabled"
},
"FailoverResponseCodes": {
"name": "FailoverResponseCodes",
"description": "Comma separated numbers between 400 and 599",
"type": "string",
"title": "Failover Response Codes"
},
"FailoverTimeSeconds": {
"name": "FailoverTimeSeconds",
"description": "When set to 10 (default value), outbound calls that are not answered by the gateway within 10 seconds are routed to the next available trunk; if there are no additional trunks, then the call is automatically dropped. In an organization with slow networks and slow gateway responses, that could potentially result in calls being dropped unnecessarily. The default value is 10.",
"type": "integer",
"title": "Failover Time Seconds"
},
"ForwardCallHistory": {
"name": "ForwardCallHistory",
"description": "Indicates whether call history information will be forwarded through the trunk. If enabled, the Office 365 PSTN Proxy sends two headers: History-info and Referred-By. The default value is False ($False).",
"type": "boolean",
"title": "Forward Call History"
},
"ForwardPai": {
"name": "ForwardPai",
"description": "Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. The PAI header provides a way to verify the identity of the caller. The default value is False ($False). Setting this parameter to $true will render the from header anonymous, in accordance of RFC5379 and RFC3325.",
"type": "boolean",
"title": "Forward PAI"
},
"Fqdn": {
"name": "Fqdn",
"description": "Fully qualified domain name",
"type": "string",
"title": "FQDN"
},
"GatewayLbrEnabledUserOverride": {
"name": "GatewayLbrEnabledUserOverride",
"type": "boolean",
"title": "Gateway LBR Enabled User Override"
},
"GatewaySiteId": {
"name": "GatewaySiteId",
"description": "PSTN Gateway Site ID.",
"type": "string",
"title": "Gateway Site ID"
},
"GatewaySiteLbrEnabled": {
"name": "GatewaySiteLbrEnabled",
"description": "Used to enable this SBC to report assigned site location. Site location is used for Location Based Routing. When this parameter is turned on, the SBC will report the site name as defined by tenant administrator. On incoming call to a Teams user the value of the site assigned to the SBC is compared with the value of the site assigned to the user to make a routing decision. The parameter is mandatory for enabling Location Based Routing feature. The default value is False ($False).",
"type": "boolean",
"title": "Gateway Site LBR Enabled"
},
"Identity": {
"name": "Identity",
"description": "The parameter is mandatory when modifying an existing SBC.",
"type": "string",
"title": "Name",
"required": true,
"readonly": true
},
"InboundPstnNumberTranslationRules": {
"name": "InboundPstnNumberTranslationRules",
"description": "Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction.",
"type": [
"array",
"null"
],
"title": "Inbound PSTN Number Translation Rules",
"items": {
"type": "string",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsTranslationRule/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsTranslationRule",
"choices": []
}
},
"InboundTeamsNumberTranslationRules": {
"name": "InboundTeamsNumberTranslationRules",
"description": "This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction.",
"type": [
"array",
"null"
],
"title": "Inbound Teams Number Translation Rules",
"items": {
"type": "string",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsTranslationRule/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsTranslationRule",
"choices": []
}
},
"MaxConcurrentSessions": {
"name": "MaxConcurrentSessions",
"description": "Used by the alerting system. When any value is set, the alerting system will generate an alert to the tenant administrator when the number of concurrent session is 90% or higher than this value. If this parameter is not set, the alerts are not generated. However, the monitoring system will report the number of concurrent sessions every 24 hours.",
"type": [
"integer",
"null"
],
"title": "Max Concurrent Sessions"
},
"MediaBypass": {
"name": "MediaBypass",
"description": "Parameter indicated of the SBC supports Media Bypass and the administrator wants to use it for this SBC.",
"type": "boolean",
"title": "Media Bypass"
},
"MediaRelayRoutingLocationOverride": {
"name": "MediaRelayRoutingLocationOverride",
"description": "This parameter is reserved for use with managed carriers. Allows selecting path for media manually. Direct Routing assigns a datacenter for media path based on the public IP of the SBC. We always select closest to the SBC datacenter. However, in some cases a public IP from for example a US range can be assigned to an SBC located in Europe. In this case we will be using not optimal media path. This parameter allows manually set the preferred region for media traffic. We only recommend setting this parameter if the call logs clearly indicate that automatic assignment of the datacenter for media path does not assign the closest to the SBC datacenter",
"type": [
"string",
"null"
],
"title": "Media Relay Routing Location Override"
},
"OutboundPstnNumberTranslationRules": {
"name": "OutboundPstnNumberTranslationRules",
"description": "Assigns an ordered list of Teams translation rules, that apply to PSTN number on outbound direction.",
"type": [
"array",
"null"
],
"title": "Outbound PSTN Number Translation Rules",
"items": {
"type": "string",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsTranslationRule/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsTranslationRule",
"choices": []
}
},
"OutboundTeamsNumberTranslationRules": {
"name": "OutboundTeamsNumberTranslationRules",
"description": "Assigns an ordered list of Teams translation rules, that apply to Teams numbers on outbound direction.",
"type": [
"array",
"null"
],
"title": "Outbound Teams Number Translation Rules",
"items": {
"type": "string",
"format": "uri",
"target": "/api/device/msteamsonline/CsTeamsTranslationRule/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsTeamsTranslationRule",
"choices": []
}
},
"PidfLoSupported": {
"name": "PidfLoSupported",
"description": "Enables PIDF-LO support on the PSTN Gateway. If turned on the .xml body payload is sent to the SBC with the location details of the user.",
"type": "boolean",
"title": "PIDF-LO Supported"
},
"ProxySbc": {
"name": "ProxySbc",
"type": [
"string",
"null"
],
"title": "Proxy SBC"
},
"SendSipOptions": {
"name": "SendSipOptions",
"description": "Defines if an SBC will or will not send the SIP options. If disabled, the SBC will be excluded from Monitoring and Alerting system. We highly recommend that you enable SIP options. Default value is True.",
"type": "boolean",
"title": "Send SIP Options"
},
"SipSignalingPort": {
"name": "SipSignalingPort",
"description": "Listening port used for communicating with Direct Routing services by using the Transport Layer Security (TLS) protocol. The value must be between 1 and 65535.",
"type": "integer",
"title": "SIP Signaling Port",
"required": true
}
},
"schema_version": "2019.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/msteamsonline/CsOnlinePstnGateway/add/ |
|
The GUI Add form of device/msteamsonline/CsOnlinePstnGateway 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/CsOnlinePstnGateway | 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/CsOnlinePstnGateway/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/msteamsonline/CsOnlinePstnGateway/[pkid1]", "/api/device/msteamsonline/CsOnlinePstnGateway/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/msteamsonline/CsOnlinePstnGateway/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/msteamsonline/CsOnlinePstnGateway/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/msteamsonline/CsOnlinePstnGateway/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/msteamsonline/CsOnlinePstnGateway/[pkid1]", "/api/v0/device/msteamsonline/CsOnlinePstnGateway/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/msteamsonline/CsOnlinePstnGateway/?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/CsOnlinePstnGateway |
|
{"hrefs": ["/api/device/msteamsonline/CsOnlinePstnGateway/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/msteamsonline/CsOnlinePstnGateway |
|
{"hrefs": ["/api/device/msteamsonline/CsOnlinePstnGateway/[pkid1]", "/api/device/msteamsonline/CsOnlinePstnGateway/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/msteamsonline/CsOnlinePstnGateway; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/msteamsonline/CsOnlinePstnGateway/export/ |
|
{ "hrefs":["/api/device/msteamsonline/CsOnlinePstnGateway/[pkid1]", "/api/device/msteamsonline/CsOnlinePstnGateway/[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/CsOnlinePstnGateway and the JSON format can be used to import instances of device/msteamsonline/CsOnlinePstnGateway.
GET http://[host-proxy]/api/device/msteamsonline/CsOnlinePstnGateway/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/msteamsonline/CsOnlinePstnGateway | POST | /api/device/msteamsonline/CsOnlinePstnGateway/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msteamsonline/CsOnlinePstnGateway/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/device/msteamsonline/CsOnlinePstnGateway/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/msteamsonline/CsOnlinePstnGateway/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/CsOnlinePstnGateway/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/CsOnlinePstnGateway/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/msteamsonline/CsOnlinePstnGateway/ |
|
The device/msteamsonline/CsOnlinePstnGateway schema and all instances as JSON. |
(The list will return 0 to 3 device/msteamsonline/CsOnlinePstnGateway instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 2,
"total_limit": null,
"order_by": "Identity",
"direction": "asc",
"current": "/api/device/msteamsonline/CsOnlinePstnGateway/?skip=0&limit=3&order_by=Identity&direction=asc&traversal=down"
},
"operations": [
"list",
"add"
],
"meta": {
"model_type": "device/msteamsonline/CsOnlinePstnGateway",
"summary_attrs": [
{
"name": "Identity",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"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"
],
"schema_version": "2019.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/msteamsonline/CsOnlinePstnGateway",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"resources": [
{
"data": {
"hierarchy": "6644e9bcf14dbdc7695d37d1",
"GatewaySiteLbrEnabled": false,
"Description": null,
"OutboundPstnNumberTranslationRules": [],
"FailoverTimeSeconds": 10,
"BypassMode": "None",
"InboundTeamsNumberTranslationRules": [],
"ForwardPai": false,
"MediaBypass": false,
"Identity": "lydiasbc.vossautobuild.onmicrosoft.com",
"InboundPstnNumberTranslationRules": [],
"ForwardCallHistory": false,
"GatewayLbrEnabledUserOverride": false,
"Enabled": false,
"Fqdn": "lydiasbc.vossautobuild.onmicrosoft.com",
"SipSignalingPort": 5067,
"PidfLoSupported": false,
"FailoverResponseCodes": "408,503,504",
"ProxySbc": null,
"MediaRelayRoutingLocationOverride": null,
"OutboundTeamsNumberTranslationRules": [],
"SendSipOptions": true,
"MaxConcurrentSessions": 24,
"summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.RND",
"hierarchy_friendly_name": "RND (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.RND"
},
"meta": {
"model_type": "device/msteamsonline/CsOnlinePstnGateway",
"summary_attrs": [
{
"name": "Identity",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "lydiasbc.vossautobuild.onmicrosoft.com",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/MSTeamsOnline/6644f420f14dbdc7695ec116",
"pkid": "6644f420f14dbdc7695ec116"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6644e9bcf14dbdc7695d37d1",
"href": "/api/data/HierarchyNode/6644e9bcf14dbdc7695d37d1"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/",
"pkid": "6644f619f14dbdc7695fbd83"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89bd5affa931cce3863f9",
"6644e9bcf14dbdc7695d37d1",
"6644f619f14dbdc7695fbd83"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/6644f619f14dbdc7695fbd83/?model_type=device/msteamsonline/CsOnlinePstnGateway",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "6644f619f14dbdc7695fbd83"
},
{
"data": {
"hierarchy": "6644e9bcf14dbdc7695d37d1",
"GatewaySiteLbrEnabled": false,
"Description": null,
"OutboundPstnNumberTranslationRules": [],
"FailoverTimeSeconds": 10,
"BypassMode": "None",
"InboundTeamsNumberTranslationRules": [],
"ForwardPai": false,
"MediaBypass": false,
"Identity": "RVDDP.vossautobuild.onmicrosoft.com",
"InboundPstnNumberTranslationRules": [
"blah"
],
"ForwardCallHistory": false,
"GatewayLbrEnabledUserOverride": false,
"Enabled": true,
"Fqdn": "RVDDP.vossautobuild.onmicrosoft.com",
"SipSignalingPort": 12345,
"PidfLoSupported": false,
"FailoverResponseCodes": "408,503,504",
"ProxySbc": null,
"MediaRelayRoutingLocationOverride": null,
"OutboundTeamsNumberTranslationRules": [],
"SendSipOptions": true,
"MaxConcurrentSessions": null,
"summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.RND",
"hierarchy_friendly_name": "RND (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.RND"
},
"meta": {
"model_type": "device/msteamsonline/CsOnlinePstnGateway",
"summary_attrs": [
{
"name": "Identity",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "RVDDP.vossautobuild.onmicrosoft.com",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/MSTeamsOnline/6644f420f14dbdc7695ec116",
"pkid": "6644f420f14dbdc7695ec116"
}
],
"parent": [
{
"pkid": "6644e9bcf14dbdc7695d37d1",
"href": "/api/data/HierarchyNode/6644e9bcf14dbdc7695d37d1"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbdb0/",
"pkid": "6644f619f14dbdc7695fbdb0"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89bd5affa931cce3863f9",
"6644e9bcf14dbdc7695d37d1",
"6644f619f14dbdc7695fbdb0"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbdb0/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbdb0/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbdb0/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/6644f619f14dbdc7695fbdb0/?model_type=device/msteamsonline/CsOnlinePstnGateway",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbdb0/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbdb0/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbdb0/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbdb0/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbdb0/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbdb0/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "6644f619f14dbdc7695fbdb0"
}
]
}
(Show the first instance)
{
"data": {
"hierarchy": "6644e9bcf14dbdc7695d37d1",
"GatewaySiteLbrEnabled": false,
"Description": null,
"OutboundPstnNumberTranslationRules": [],
"FailoverTimeSeconds": 10,
"BypassMode": "None",
"InboundTeamsNumberTranslationRules": [],
"ForwardPai": false,
"MediaBypass": false,
"Identity": "lydiasbc.vossautobuild.onmicrosoft.com",
"InboundPstnNumberTranslationRules": [],
"ForwardCallHistory": false,
"GatewayLbrEnabledUserOverride": false,
"Enabled": false,
"Fqdn": "lydiasbc.vossautobuild.onmicrosoft.com",
"SipSignalingPort": 5067,
"PidfLoSupported": false,
"FailoverResponseCodes": "408,503,504",
"ProxySbc": null,
"MediaRelayRoutingLocationOverride": null,
"OutboundTeamsNumberTranslationRules": [],
"SendSipOptions": true,
"MaxConcurrentSessions": 24
},
"meta": {
"model_type": "device/msteamsonline/CsOnlinePstnGateway",
"summary_attrs": [
{
"name": "Identity",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "lydiasbc.vossautobuild.onmicrosoft.com",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "/api/v0/data/MSTeamsOnline/6644f420f14dbdc7695ec116",
"pkid": "6644f420f14dbdc7695ec116"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/6644e9bcf14dbdc7695d37d1",
"pkid": "6644e9bcf14dbdc7695d37d1"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/",
"pkid": "6644f619f14dbdc7695fbd83"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89bd5affa931cce3863f9",
"6644e9bcf14dbdc7695d37d1",
"6644f619f14dbdc7695fbd83"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/6644f619f14dbdc7695fbd83/?hierarchy=[hierarchy]&model_type=device/msteamsonline/CsOnlinePstnGateway",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msteamsonline/CsOnlinePstnGateway/6644f619f14dbdc7695fbd83/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"pkid": "6644f619f14dbdc7695fbd83"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/msteamsonline/CsOnlinePstnGateway. | GET | /api/device/msteamsonline/CsOnlinePstnGateway/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/msteamsonline/CsOnlinePstnGateway as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/msteamsonline/CsOnlinePstnGateway/purge/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/device/msteamsonline/CsOnlinePstnGateway/transform/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/msteamsonline/CsOnlinePstnGateway/[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/CsOnlinePstnGateway/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/msteamsonline/CsOnlinePstnGateway/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/msteamsonline/CsOnlinePstnGateway/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/msteamsonline/CsOnlinePstnGateway | 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/CsOnlinePstnGateway; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/msteamsonline/CsOnlinePstnGateway/[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/CsOnlinePstnGateway and the JSON format can be used to import instances of device/msteamsonline/CsOnlinePstnGateway.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msteamsonline/CsOnlinePstnGateway/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/msteamsonline/CsOnlinePstnGateway/[pkid] | hierarchy=[hierarchy] | The device/msteamsonline/CsOnlinePstnGateway instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/msteamsonline/CsOnlinePstnGateway/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/msteamsonline/CsOnlinePstnGateway. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/msteamsonline/CsOnlinePstnGateway/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |