[Index]
Model ref.: device/msteamsonline/CsOnlineLisLocation
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": {
"NumberOfVoiceUsers": {
"readonly": true,
"type": "integer",
"name": "NumberOfVoiceUsers",
"title": "Number Of Voice Users"
},
"City": {
"readonly": true,
"type": "string",
"name": "City",
"title": "City"
},
"Confidence": {
"readonly": true,
"type": "string",
"name": "Confidence",
"title": "Confidence"
},
"CivicAddressId": {
"readonly": true,
"description": "Specifies the unique identifier of the civic address that contains the location.",
"type": "string",
"name": "CivicAddressId",
"title": "Civic Address ID"
},
"Location": {
"description": "Specifies an administrator defined description of the location. For example, \"2nd Floor Cafe\", \"Main Lobby\", or \"Office 250\".",
"type": "string",
"name": "Location",
"title": "Location"
},
"Latitude": {
"readonly": true,
"type": "string",
"name": "Latitude",
"title": "Latitude"
},
"NumberOfTelephoneNumbers": {
"readonly": true,
"type": "integer",
"name": "NumberOfTelephoneNumbers",
"title": "Number Of Telephone Numbers"
},
"CompanyTaxId": {
"readonly": true,
"type": "string",
"name": "CompanyTaxId",
"title": "Company Tax ID"
},
"Description": {
"readonly": true,
"description": "Specifies an administrator defined description of the civic address.",
"type": "string",
"name": "Description",
"title": "Description"
},
"CivicAddress": {
"target": "/api/device/msteamsonline/CsOnlineLisCivicAddress/choices/?field=CompanyName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Civic Address",
"convert_to_primary_key": true,
"name": "CivicAddress",
"target_attr": "CompanyName",
"target_model_type": "device/msteamsonline/CsOnlineLisCivicAddress",
"choices": [],
"type": "string",
"description": "Friendly name for the civic address that contains the location."
},
"PartnerId": {
"readonly": true,
"type": "string",
"name": "PartnerId",
"title": "Partner ID"
},
"ValidationStatus": {
"readonly": true,
"description": "Validated addresses cannot be changed, the address must be removed and added again.",
"type": "string",
"name": "ValidationStatus",
"title": "Validation Status"
},
"PreDirectional": {
"readonly": true,
"type": "string",
"name": "PreDirectional",
"title": "Pre Directional"
},
"CityAlias": {
"readonly": true,
"type": "string",
"name": "CityAlias",
"title": "City Alias"
},
"Longitude": {
"readonly": true,
"type": "string",
"name": "Longitude",
"title": "Longitude"
},
"StreetSuffix": {
"readonly": true,
"type": "string",
"name": "StreetSuffix",
"title": "Street Suffix"
},
"PostalCode": {
"readonly": true,
"type": "string",
"name": "PostalCode",
"title": "Postal Code"
},
"TenantId": {
"readonly": true,
"type": "string",
"name": "TenantId",
"title": "Tenant ID"
},
"IsDefault": {
"readonly": true,
"type": "boolean",
"name": "IsDefault",
"title": "Is Default"
},
"HouseNumberSuffix": {
"readonly": true,
"type": "string",
"name": "HouseNumberSuffix",
"title": "House Number Suffix"
},
"CompanyName": {
"readonly": true,
"type": "string",
"name": "CompanyName",
"title": "Company Name"
},
"Elin": {
"description": "Specifies the Emergency Location Identification Number. This is used in Direct Routing EGW scenarios.",
"type": "string",
"name": "Elin",
"title": "ELIN"
},
"CountyOrDistrict": {
"readonly": true,
"type": "string",
"name": "CountyOrDistrict",
"title": "County Or District"
},
"LocationId": {
"readonly": true,
"type": "string",
"name": "LocationId",
"title": "Location ID"
},
"PostDirectional": {
"readonly": true,
"type": "string",
"name": "PostDirectional",
"title": "Post Directional"
},
"CountryOrRegion": {
"readonly": true,
"type": "string",
"name": "CountryOrRegion",
"title": "Country Or Region"
},
"StateOrProvince": {
"readonly": true,
"type": "string",
"name": "StateOrProvince",
"title": "State Or Province"
},
"HouseNumber": {
"readonly": true,
"type": "string",
"name": "HouseNumber",
"title": "House Number"
},
"StreetName": {
"readonly": true,
"type": "string",
"name": "StreetName",
"title": "Street Name"
}
},
"schema_version": "2019.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/msteamsonline/CsOnlineLisLocation/add/ |
|
The GUI Add form of device/msteamsonline/CsOnlineLisLocation 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/CsOnlineLisLocation | 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/CsOnlineLisLocation/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/msteamsonline/CsOnlineLisLocation/[pkid1]", "/api/device/msteamsonline/CsOnlineLisLocation/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/msteamsonline/CsOnlineLisLocation/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/msteamsonline/CsOnlineLisLocation/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/msteamsonline/CsOnlineLisLocation/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/msteamsonline/CsOnlineLisLocation/[pkid1]", "/api/v0/device/msteamsonline/CsOnlineLisLocation/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/msteamsonline/CsOnlineLisLocation/?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/CsOnlineLisLocation |
|
{"hrefs": ["/api/device/msteamsonline/CsOnlineLisLocation/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/msteamsonline/CsOnlineLisLocation |
|
{"hrefs": ["/api/device/msteamsonline/CsOnlineLisLocation/[pkid1]", "/api/device/msteamsonline/CsOnlineLisLocation/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/msteamsonline/CsOnlineLisLocation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/msteamsonline/CsOnlineLisLocation/export/ |
|
{ "hrefs":["/api/device/msteamsonline/CsOnlineLisLocation/[pkid1]", "/api/device/msteamsonline/CsOnlineLisLocation/[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/CsOnlineLisLocation and the JSON format can be used to import instances of device/msteamsonline/CsOnlineLisLocation.
GET http://[host-proxy]/api/device/msteamsonline/CsOnlineLisLocation/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/msteamsonline/CsOnlineLisLocation | POST | /api/device/msteamsonline/CsOnlineLisLocation/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/CsOnlineLisLocation/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/CsOnlineLisLocation/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/CsOnlineLisLocation/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/msteamsonline/CsOnlineLisLocation/ |
|
The device/msteamsonline/CsOnlineLisLocation schema and all instances as JSON. |
(The list will return 0 to 3 device/msteamsonline/CsOnlineLisLocation instances)
{
"operations": [
"list",
"add"
],
"pagination": {
"direction": "asc",
"order_by": "Location",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/msteamsonline/CsOnlineLisLocation/?skip=0&limit=3&order_by=Location&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 9
},
"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/CsOnlineLisLocation/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/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/CsOnlineLisLocation",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/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/CsOnlineLisLocation/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/+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/CsOnlineLisLocation/+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/CsOnlineLisLocation/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "device/msteamsonline/CsOnlineLisLocation",
"model_specific_actions": [
"list",
"add",
"get",
"update",
"remove",
"move",
"clone",
"export",
"export_bulkload_template",
"bulk_update_form",
"configuration_template",
"field_display_policy",
"help",
"migration",
"transform",
"tag",
"tag_version"
],
"summary_attrs": [
{
"name": "Location",
"title": "Location"
},
{
"name": "CompanyName",
"title": "Company Name"
},
{
"name": "City",
"title": "City"
},
{
"name": "CountryOrRegion",
"title": "Country Or Region"
},
{
"name": "Elin",
"title": "ELIN"
},
{
"name": "IsDefault",
"title": "Is Default"
},
{
"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": "655efeca40d96fe47c256836",
"meta": {
"tags": [],
"cached": true,
"title": "dries-Test4_default",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "655efaa040d96fe47c23f48e",
"href": "/api/v0/data/MSTeamsOnline/655efaa040d96fe47c23f48e"
}
],
"self": [
{
"pkid": "655efeca40d96fe47c256836",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256836/"
}
],
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256836/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256836/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256836/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/655efeca40d96fe47c256836/?model_type=device/msteamsonline/CsOnlineLisLocation",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256836/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256836/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256836/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256836/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256836/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256836/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/msteamsonline/CsOnlineLisLocation",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efeca40d96fe47c256836"
],
"summary_attrs": [
{
"name": "Location",
"title": "Location"
},
{
"name": "CompanyName",
"title": "Company Name"
},
{
"name": "City",
"title": "City"
},
{
"name": "CountryOrRegion",
"title": "Country Or Region"
},
{
"name": "Elin",
"title": "ELIN"
},
{
"name": "IsDefault",
"title": "Is Default"
},
{
"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": {
"NumberOfVoiceUsers": -1,
"CountryOrRegion": "ZA",
"CivicAddress": "dries-Test4",
"CompanyName": "dries-Test4",
"hierarchy": "655ef9d340d96fe47c238be3",
"CivicAddressId": "b021f287-3ab9-4b28-a902-f860be832907",
"PartnerId": "00000000-0000-0000-0000-000000000000",
"Location": "dries-Test4_default",
"ValidationStatus": "Validated",
"summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild",
"LocationId": "4e3cea97-71f1-4fe0-839e-5482c585b591",
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"TenantId": "6e6e313c-6fac-4f8d-a152-f8284f723f19",
"NumberOfTelephoneNumbers": -1,
"IsDefault": true,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
},
{
"pkid": "655efeca40d96fe47c25683e",
"meta": {
"tags": [],
"cached": true,
"title": "dries-Test4_default2",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "655efaa040d96fe47c23f48e",
"href": "/api/v0/data/MSTeamsOnline/655efaa040d96fe47c23f48e"
}
],
"self": [
{
"pkid": "655efeca40d96fe47c25683e",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c25683e/"
}
],
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c25683e/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c25683e/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c25683e/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/655efeca40d96fe47c25683e/?model_type=device/msteamsonline/CsOnlineLisLocation",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c25683e/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c25683e/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c25683e/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c25683e/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c25683e/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c25683e/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/msteamsonline/CsOnlineLisLocation",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efeca40d96fe47c25683e"
],
"summary_attrs": [
{
"name": "Location",
"title": "Location"
},
{
"name": "CompanyName",
"title": "Company Name"
},
{
"name": "City",
"title": "City"
},
{
"name": "CountryOrRegion",
"title": "Country Or Region"
},
{
"name": "Elin",
"title": "ELIN"
},
{
"name": "IsDefault",
"title": "Is Default"
},
{
"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": {
"NumberOfVoiceUsers": -1,
"CountryOrRegion": "ZA",
"CivicAddress": "dries-Test4",
"CompanyName": "dries-Test4",
"hierarchy": "655ef9d340d96fe47c238be3",
"CivicAddressId": "b021f287-3ab9-4b28-a902-f860be832907",
"PartnerId": "00000000-0000-0000-0000-000000000000",
"Location": "dries-Test4_default2",
"ValidationStatus": "Validated",
"summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild",
"LocationId": "05889d68-97a2-4a67-bef6-e85677336cbf",
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"TenantId": "6e6e313c-6fac-4f8d-a152-f8284f723f19",
"NumberOfTelephoneNumbers": -1,
"IsDefault": false,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
},
{
"pkid": "655efeca40d96fe47c256832",
"meta": {
"tags": [],
"cached": true,
"title": "dries-Test6_default",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "655efaa040d96fe47c23f48e",
"href": "/api/v0/data/MSTeamsOnline/655efaa040d96fe47c23f48e"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "655efeca40d96fe47c256832",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256832/"
}
],
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256832/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256832/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256832/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/655efeca40d96fe47c256832/?model_type=device/msteamsonline/CsOnlineLisLocation",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256832/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256832/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256832/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256832/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256832/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256832/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/msteamsonline/CsOnlineLisLocation",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efeca40d96fe47c256832"
],
"summary_attrs": [
{
"name": "Location",
"title": "Location"
},
{
"name": "CompanyName",
"title": "Company Name"
},
{
"name": "City",
"title": "City"
},
{
"name": "CountryOrRegion",
"title": "Country Or Region"
},
{
"name": "Elin",
"title": "ELIN"
},
{
"name": "IsDefault",
"title": "Is Default"
},
{
"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": {
"NumberOfVoiceUsers": -1,
"CountryOrRegion": "ZA",
"CivicAddress": "dries-Test6",
"CompanyName": "dries-Test6",
"hierarchy": "655ef9d340d96fe47c238be3",
"summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild",
"Longitude": "40.00",
"CivicAddressId": "e9495561-0a01-4aa6-9623-aa9fbbc94ad2",
"PartnerId": "00000000-0000-0000-0000-000000000000",
"Location": "dries-Test6_default",
"ValidationStatus": "Validated",
"Latitude": "30.00",
"LocationId": "a794cc50-1009-4338-a251-808b15382858",
"hierarchy_friendly_name": "VossAutoBuild (Customer)",
"TenantId": "6e6e313c-6fac-4f8d-a152-f8284f723f19",
"NumberOfTelephoneNumbers": -1,
"IsDefault": true,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild"
}
}
]
}
(Show the first instance)
{
"pkid": "655efeca40d96fe47c256836",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "dries-Test4_default",
"business_key": {},
"schema_version": "",
"references": {
"parent": [
{
"pkid": "655ef9d340d96fe47c238be3",
"href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3"
}
],
"self": [
{
"pkid": "655efeca40d96fe47c256836",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256836/"
}
],
"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/CsOnlineLisLocation/655efeca40d96fe47c256836/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256836/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256836/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/655efeca40d96fe47c256836/?hierarchy=[hierarchy]&model_type=device/msteamsonline/CsOnlineLisLocation",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256836/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/CsOnlineLisLocation/655efeca40d96fe47c256836/+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/CsOnlineLisLocation/655efeca40d96fe47c256836/+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/CsOnlineLisLocation/655efeca40d96fe47c256836/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256836/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/msteamsonline/CsOnlineLisLocation/655efeca40d96fe47c256836/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/msteamsonline/CsOnlineLisLocation",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"655ef9d340d96fe47c238be3",
"655efeca40d96fe47c256836"
],
"summary_attrs": [
{
"name": "Location",
"title": "Location"
},
{
"name": "CompanyName",
"title": "Company Name"
},
{
"name": "City",
"title": "City"
},
{
"name": "CountryOrRegion",
"title": "Country Or Region"
},
{
"name": "Elin",
"title": "ELIN"
},
{
"name": "IsDefault",
"title": "Is Default"
},
{
"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": {
"NumberOfVoiceUsers": -1,
"CivicAddress": "dries-Test4",
"CompanyName": "dries-Test4",
"hierarchy": "655ef9d340d96fe47c238be3",
"CivicAddressId": "b021f287-3ab9-4b28-a902-f860be832907",
"PartnerId": "00000000-0000-0000-0000-000000000000",
"Location": "dries-Test4_default",
"ValidationStatus": "Validated",
"LocationId": "4e3cea97-71f1-4fe0-839e-5482c585b591",
"NumberOfTelephoneNumbers": -1,
"TenantId": "6e6e313c-6fac-4f8d-a152-f8284f723f19",
"CountryOrRegion": "ZA",
"IsDefault": true
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/msteamsonline/CsOnlineLisLocation. | GET | /api/device/msteamsonline/CsOnlineLisLocation/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/msteamsonline/CsOnlineLisLocation as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/msteamsonline/CsOnlineLisLocation/[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/CsOnlineLisLocation/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/msteamsonline/CsOnlineLisLocation/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/msteamsonline/CsOnlineLisLocation/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/msteamsonline/CsOnlineLisLocation | 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/CsOnlineLisLocation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/msteamsonline/CsOnlineLisLocation/[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/CsOnlineLisLocation and the JSON format can be used to import instances of device/msteamsonline/CsOnlineLisLocation.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msteamsonline/CsOnlineLisLocation/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/msteamsonline/CsOnlineLisLocation/[pkid] | hierarchy=[hierarchy] | The device/msteamsonline/CsOnlineLisLocation instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/msteamsonline/CsOnlineLisLocation/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/msteamsonline/CsOnlineLisLocation. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/msteamsonline/CsOnlineLisLocation/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |