[Index]
Model ref.: device/msteamsonline/Number
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": {
"ActivationState": {
"name": "ActivationState",
"type": "string",
"title": "Activation State",
"readonly": true,
"choices": [
{
"value": "Activated",
"title": "Activated"
},
{
"value": "AssignmentPending",
"title": "Assignment Pending"
},
{
"value": "AssignmentFailed",
"title": "Assignment Failed"
},
{
"value": "UpdatePending",
"title": "Update Pending"
},
{
"value": "UpdateFailed",
"title": "Update Failed"
}
]
},
"Assigned": {
"name": "Assigned",
"type": "boolean",
"title": "Assigned",
"readonly": true
},
"AssignedPstnTargetId": {
"name": "AssignedPstnTargetId",
"type": "string",
"title": "Assigned PSTN Target ID",
"readonly": true
},
"Capability": {
"name": "Capability",
"type": "array",
"title": "Capabilities",
"readonly": true,
"items": {
"type": "string",
"readonly": true,
"choices": [
{
"value": "ConferenceAssignment",
"title": "Conference Assignment"
},
{
"value": "VoiceApplicationAssignment",
"title": "Voice Application Assignment"
},
{
"value": "UserAssignment",
"title": "User Assignment"
},
{
"value": "OCMobile",
"title": "OC Mobile"
}
]
}
},
"CivicAddressId": {
"name": "CivicAddressId",
"type": "string",
"title": "Civic Address",
"readonly": true,
"format": "uri",
"target": "/api/device/msteamsonline/CsOnlineLisCivicAddress/choices/?field=CompanyName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"convert_to_primary_key": true,
"target_attr": "CompanyName",
"target_model_type": "device/msteamsonline/CsOnlineLisCivicAddress",
"choices": []
},
"IsoCountryCode": {
"name": "IsoCountryCode",
"type": "string",
"title": "ISO Country Code",
"readonly": true,
"choices": [
{
"value": "AF",
"title": "Afghanistan"
},
{
"value": "AX",
"title": "\u00c5land Islands"
},
{
"value": "AL",
"title": "Albania"
},
{
"value": "DZ",
"title": "Algeria"
},
{
"value": "AS",
"title": "American Samoa"
},
{
"value": "AD",
"title": "Andorra"
},
{
"value": "AO",
"title": "Angola"
},
{
"value": "AI",
"title": "Anguilla"
},
{
"value": "AQ",
"title": "Antarctica"
},
{
"value": "AG",
"title": "Antigua and Barbuda"
},
{
"value": "AR",
"title": "Argentina"
},
{
"value": "AM",
"title": "Armenia"
},
{
"value": "AW",
"title": "Aruba"
},
{
"value": "AU",
"title": "Australia"
},
{
"value": "AT",
"title": "Austria"
},
{
"value": "AZ",
"title": "Azerbaijan"
},
{
"value": "BS",
"title": "Bahamas, The"
},
{
"value": "BH",
"title": "Bahrain"
},
{
"value": "BD",
"title": "Bangladesh"
},
{
"value": "BB",
"title": "Barbados"
},
{
"value": "BY",
"title": "Belarus"
},
{
"value": "BE",
"title": "Belgium"
},
{
"value": "BZ",
"title": "Belize"
},
{
"value": "BJ",
"title": "Benin"
},
{
"value": "BM",
"title": "Bermuda"
},
{
"value": "BT",
"title": "Bhutan"
},
{
"value": "BT",
"title": "Bolivia"
},
{
"value": "BO",
"title": "Bonaire, Saint Eustatius and Saba"
},
{
"value": "BA",
"title": "Bosnia and Herzegovina"
},
{
"value": "BW",
"title": "Botswana"
},
{
"value": "BV",
"title": "Bouvet Island"
},
{
"value": "BR",
"title": "Brazil"
},
{
"value": "IO",
"title": "British Indian Ocean Territory"
},
{
"value": "IO",
"title": "Brunei"
},
{
"value": "BG",
"title": "Bulgaria"
},
{
"value": "BF",
"title": "Burkina Faso"
},
{
"value": "BI",
"title": "Burundi"
},
{
"value": "CV",
"title": "Cabo Verde"
},
{
"value": "KH",
"title": "Cambodia"
},
{
"value": "CM",
"title": "Cameroon"
},
{
"value": "CA",
"title": "Canada"
},
{
"value": "KY",
"title": "Cayman Islands"
},
{
"value": "CF",
"title": "Central African Republic"
},
{
"value": "TD",
"title": "Chad"
},
{
"value": "CL",
"title": "Chile"
},
{
"value": "CN",
"title": "China"
},
{
"value": "CX",
"title": "Christmas Island"
},
{
"value": "CC",
"title": "Cocos (Keeling) Islands"
},
{
"value": "CO",
"title": "Colombia"
},
{
"value": "KM",
"title": "Comoros"
},
{
"value": "CG",
"title": "Congo"
},
{
"value": "CG",
"title": "Congo (DRC)"
},
{
"value": "CK",
"title": "Cook Islands"
},
{
"value": "CR",
"title": "Costa Rica"
},
{
"value": "CR",
"title": "C\u00f4te d\u2019Ivoire"
},
{
"value": "HR",
"title": "Croatia"
},
{
"value": "CW",
"title": "Cura\u00e7ao"
},
{
"value": "CY",
"title": "Cyprus"
},
{
"value": "CY",
"title": "Czech Republic"
},
{
"value": "DK",
"title": "Denmark"
},
{
"value": "DJ",
"title": "Djibouti"
},
{
"value": "DM",
"title": "Dominica"
},
{
"value": "DO",
"title": "Dominican Republic"
},
{
"value": "EC",
"title": "Ecuador"
},
{
"value": "EG",
"title": "Egypt"
},
{
"value": "SV",
"title": "El Salvador"
},
{
"value": "GQ",
"title": "Equatorial Guinea"
},
{
"value": "ER",
"title": "Eritrea"
},
{
"value": "EE",
"title": "Estonia"
},
{
"value": "ET",
"title": "Ethiopia"
},
{
"value": "ET",
"title": "Falkland Islands (Islas Malvinas)"
},
{
"value": "FO",
"title": "Faroe Islands"
},
{
"value": "FJ",
"title": "Fiji Islands"
},
{
"value": "FI",
"title": "Finland"
},
{
"value": "FR",
"title": "France"
},
{
"value": "GF",
"title": "French Guiana"
},
{
"value": "PF",
"title": "French Polynesia"
},
{
"value": "PF",
"title": "French Southern and Antarctic Lands"
},
{
"value": "GA",
"title": "Gabon"
},
{
"value": "GM",
"title": "Gambia, The"
},
{
"value": "GE",
"title": "Georgia"
},
{
"value": "DE",
"title": "Germany"
},
{
"value": "GH",
"title": "Ghana"
},
{
"value": "GI",
"title": "Gibraltar"
},
{
"value": "GR",
"title": "Greece"
},
{
"value": "GL",
"title": "Greenland"
},
{
"value": "GD",
"title": "Grenada"
},
{
"value": "GP",
"title": "Guadeloupe"
},
{
"value": "GU",
"title": "Guam"
},
{
"value": "GT",
"title": "Guatemala"
},
{
"value": "GG",
"title": "Guernsey"
},
{
"value": "GN",
"title": "Guinea"
},
{
"value": "GW",
"title": "Guinea-Bissau"
},
{
"value": "GY",
"title": "Guyana"
},
{
"value": "HT",
"title": "Haiti"
},
{
"value": "HM",
"title": "Heard Island and McDonald Islands"
},
{
"value": "VA",
"title": "Holy See (Vatican City State)"
},
{
"value": "HN",
"title": "Honduras"
},
{
"value": "HK",
"title": "Hong Kong SAR"
},
{
"value": "HU",
"title": "Hungary"
},
{
"value": "IS",
"title": "Iceland"
},
{
"value": "IN",
"title": "India"
},
{
"value": "ID",
"title": "Indonesia"
},
{
"value": "IQ",
"title": "Iraq"
},
{
"value": "IE",
"title": "Ireland"
},
{
"value": "IM",
"title": "Isle of Man"
},
{
"value": "IL",
"title": "Israel"
},
{
"value": "IT",
"title": "Italy"
},
{
"value": "JM",
"title": "Jamaica"
},
{
"value": "JP",
"title": "Japan"
},
{
"value": "JE",
"title": "Jersey"
},
{
"value": "JO",
"title": "Jordan"
},
{
"value": "KZ",
"title": "Kazakhstan"
},
{
"value": "KE",
"title": "Kenya"
},
{
"value": "KI",
"title": "Kiribati"
},
{
"value": "KR",
"title": "Korea, Republic of"
},
{
"value": "KW",
"title": "Kuwait"
},
{
"value": "KG",
"title": "Kyrgyzstan"
},
{
"value": "LA",
"title": "Laos"
},
{
"value": "LV",
"title": "Latvia"
},
{
"value": "LB",
"title": "Lebanon"
},
{
"value": "LS",
"title": "Lesotho"
},
{
"value": "LR",
"title": "Liberia"
},
{
"value": "LY",
"title": "Libya"
},
{
"value": "LI",
"title": "Liechtenstein"
},
{
"value": "LT",
"title": "Lithuania"
},
{
"value": "LU",
"title": "Luxembourg"
},
{
"value": "MO",
"title": "Macao SAR"
},
{
"value": "MO",
"title": "Macedonia, Former Yugoslav Republic of"
},
{
"value": "MG",
"title": "Madagascar"
},
{
"value": "MW",
"title": "Malawi"
},
{
"value": "MY",
"title": "Malaysia"
},
{
"value": "MV",
"title": "Maldives"
},
{
"value": "ML",
"title": "Mali"
},
{
"value": "MT",
"title": "Malta"
},
{
"value": "MH",
"title": "Marshall Islands"
},
{
"value": "MQ",
"title": "Martinique"
},
{
"value": "MR",
"title": "Mauritania"
},
{
"value": "MU",
"title": "Mauritius"
},
{
"value": "YT",
"title": "Mayotte"
},
{
"value": "MX",
"title": "Mexico"
},
{
"value": "MX",
"title": "Micronesia"
},
{
"value": "FM",
"title": "Moldova"
},
{
"value": "MC",
"title": "Monaco"
},
{
"value": "MN",
"title": "Mongolia"
},
{
"value": "ME",
"title": "Montenegro"
},
{
"value": "MS",
"title": "Montserrat"
},
{
"value": "MA",
"title": "Morocco"
},
{
"value": "MZ",
"title": "Mozambique"
},
{
"value": "MM",
"title": "Myanmar"
},
{
"value": "NA",
"title": "Namibia"
},
{
"value": "NR",
"title": "Nauru"
},
{
"value": "NP",
"title": "Nepal"
},
{
"value": "NP",
"title": "Netherlands"
},
{
"value": "NP",
"title": "Netherlands Antilles (Former)"
},
{
"value": "NC",
"title": "New Caledonia"
},
{
"value": "NZ",
"title": "New Zealand"
},
{
"value": "NI",
"title": "Nicaragua"
},
{
"value": "NE",
"title": "Niger"
},
{
"value": "NG",
"title": "Nigeria"
},
{
"value": "NU",
"title": "Niue"
},
{
"value": "NF",
"title": "Norfolk Island"
},
{
"value": "MP",
"title": "Northern Mariana Islands"
},
{
"value": "NO",
"title": "Norway"
},
{
"value": "OM",
"title": "Oman"
},
{
"value": "PK",
"title": "Pakistan"
},
{
"value": "PW",
"title": "Palau"
},
{
"value": "PS",
"title": "Palestinian Authority"
},
{
"value": "PA",
"title": "Panama"
},
{
"value": "PG",
"title": "Papua New Guinea"
},
{
"value": "PY",
"title": "Paraguay"
},
{
"value": "PE",
"title": "Peru"
},
{
"value": "PH",
"title": "Philippines"
},
{
"value": "PN",
"title": "Pitcairn Islands"
},
{
"value": "PL",
"title": "Poland"
},
{
"value": "PT",
"title": "Portugal"
},
{
"value": "PR",
"title": "Puerto Rico"
},
{
"value": "QA",
"title": "Qatar"
},
{
"value": "QA",
"title": "Reunion"
},
{
"value": "RO",
"title": "Romania"
},
{
"value": "RO",
"title": "Russia"
},
{
"value": "RW",
"title": "Rwanda"
},
{
"value": "BL",
"title": "Saint Barth\u00e9lemy"
},
{
"value": "SH",
"title": "Saint Helena, Ascension and Tristan da Cunha"
},
{
"value": "KN",
"title": "Saint Kitts and Nevis"
},
{
"value": "LC",
"title": "Saint Lucia"
},
{
"value": "LC",
"title": "Saint Martin"
},
{
"value": "PM",
"title": "Saint Pierre and Miquelon"
},
{
"value": "VC",
"title": "Saint Vincent and the Grenadines"
},
{
"value": "WS",
"title": "Samoa"
},
{
"value": "SM",
"title": "San Marino"
},
{
"value": "ST",
"title": "S\u00e3o Tom\u00e9 and Pr\u00edncipe"
},
{
"value": "SA",
"title": "Saudi Arabia"
},
{
"value": "SN",
"title": "Senegal"
},
{
"value": "RS",
"title": "Serbia"
},
{
"value": "SC",
"title": "Seychelles"
},
{
"value": "SL",
"title": "Sierra Leone"
},
{
"value": "SG",
"title": "Singapore"
},
{
"value": "SG",
"title": "Sint Maarten"
},
{
"value": "SK",
"title": "Slovakia"
},
{
"value": "SI",
"title": "Slovenia"
},
{
"value": "SB",
"title": "Solomon Islands"
},
{
"value": "SO",
"title": "Somalia"
},
{
"value": "ZA",
"title": "South Africa"
},
{
"value": "GS",
"title": "South Georgia and the South Sandwich Islands"
},
{
"value": "SS",
"title": "South Sudan"
},
{
"value": "ES",
"title": "Spain"
},
{
"value": "LK",
"title": "Sri Lanka"
},
{
"value": "SR",
"title": "Suriname"
},
{
"value": "SJ",
"title": "Svalbard and Jan Mayen Island"
},
{
"value": "SZ",
"title": "Swaziland"
},
{
"value": "SE",
"title": "Sweden"
},
{
"value": "CH",
"title": "Switzerland"
},
{
"value": "SY",
"title": "Taiwan"
},
{
"value": "TJ",
"title": "Tajikistan"
},
{
"value": "TJ",
"title": "Tanzania"
},
{
"value": "TH",
"title": "Thailand"
},
{
"value": "TL",
"title": "Timor-Leste"
},
{
"value": "TG",
"title": "Togo"
},
{
"value": "TK",
"title": "Tokelau"
},
{
"value": "TO",
"title": "Tonga"
},
{
"value": "TT",
"title": "Trinidad and Tobago"
},
{
"value": "TN",
"title": "Tunisia"
},
{
"value": "TR",
"title": "Turkey"
},
{
"value": "TM",
"title": "Turkmenistan"
},
{
"value": "TC",
"title": "Turks and Caicos Islands"
},
{
"value": "TV",
"title": "Tuvalu"
},
{
"value": "TV",
"title": "U.S. Minor Outlying Islands"
},
{
"value": "UG",
"title": "Uganda"
},
{
"value": "UA",
"title": "Ukraine"
},
{
"value": "AE",
"title": "United Arab Emirates"
},
{
"value": "GB",
"title": "United Kingdom"
},
{
"value": "US",
"title": "United States"
},
{
"value": "UY",
"title": "Uruguay"
},
{
"value": "UZ",
"title": "Uzbekistan"
},
{
"value": "VU",
"title": "Vanuatu"
},
{
"value": "VU",
"title": "Venezuela"
},
{
"value": "VN",
"title": "Vietnam"
},
{
"value": "VG",
"title": "Virgin Islands, British"
},
{
"value": "VI",
"title": "Virgin Islands, U.S."
},
{
"value": "WF",
"title": "Wallis and Futuna"
},
{
"value": "EH",
"title": "Western Sahara"
},
{
"value": "YE",
"title": "Yemen"
},
{
"value": "ZM",
"title": "Zambia"
},
{
"value": "ZW",
"title": "Zimbabwe"
}
]
},
"LocationId": {
"name": "LocationId",
"type": "string",
"title": "Location",
"readonly": true,
"format": "uri",
"target": "/api/device/msteamsonline/CsOnlineLisLocation/choices/?field=Location&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Location",
"convert_to_primary_key": true,
"target_model_type": "device/msteamsonline/CsOnlineLisLocation",
"choices": []
},
"LocationUpdateSupported": {
"name": "LocationUpdateSupported",
"type": "boolean",
"title": "Location Update Supported",
"readonly": true
},
"Number": {
"name": "Number",
"type": "string",
"title": "Number",
"readonly": true
},
"Numbertel": {
"name": "Numbertel",
"type": "string",
"title": "Number Base",
"readonly": true
},
"Numberext": {
"name": "Numberext",
"type": "string",
"title": "Number Extension",
"readonly": true
},
"NumberType": {
"name": "NumberType",
"type": "string",
"title": "Number Type",
"readonly": true,
"choices": [
{
"value": "DirectRouting",
"title": "Direct Routing"
},
{
"value": "CallingPlan",
"title": "Calling Plan"
},
{
"value": "OperatorConnect",
"title": "Operator Connect"
}
]
},
"PortInOrderStatus": {
"name": "PortInOrderStatus",
"type": "string",
"title": "Port In Order Status",
"readonly": true
},
"PstnAssignmentStatus": {
"name": "PstnAssignmentStatus",
"type": "string",
"title": "PSTN Assignment Status",
"readonly": true,
"choices": [
{
"value": "Unassigned",
"title": "Unassigned"
},
{
"value": "UserAssigned",
"title": "User Assigned"
},
{
"value": "ConferenceAssigned",
"title": "Conference Assigned"
},
{
"value": "VoiceApplicationAssigned",
"title": "Voice Application Assigned"
},
{
"value": "ThirdPartyAppAssigned",
"title": "Third Party App Assigned"
}
]
},
"PstnPartnerId": {
"name": "PstnPartnerId",
"type": "string",
"title": "PSTN Partner ID",
"readonly": true
},
"PstnPartnerName": {
"name": "PstnPartnerName",
"type": "string",
"title": "PSTN Partner Name",
"readonly": true
}
},
"schema_version": "2019.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/msteamsonline/Number/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/msteamsonline/Number/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/msteamsonline/Number/[pkid1]", "/api/v0/device/msteamsonline/Number/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/msteamsonline/Number/?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/Number |
|
{"hrefs": ["/api/device/msteamsonline/Number/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/msteamsonline/Number |
|
{"hrefs": ["/api/device/msteamsonline/Number/[pkid1]", "/api/device/msteamsonline/Number/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/msteamsonline/Number; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/msteamsonline/Number/export/ |
|
{ "hrefs":["/api/device/msteamsonline/Number/[pkid1]", "/api/device/msteamsonline/Number/[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/Number and the JSON format can be used to import instances of device/msteamsonline/Number.
GET http://[host-proxy]/api/device/msteamsonline/Number/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/msteamsonline/Number | POST | /api/device/msteamsonline/Number/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/Number/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/device/msteamsonline/Number/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/msteamsonline/Number/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/Number/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/Number/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/msteamsonline/Number/ |
|
The device/msteamsonline/Number schema and all instances as JSON. |
(The list will return 0 to 3 device/msteamsonline/Number instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 10,
"total_limit": null,
"order_by": "Number",
"direction": "asc",
"current": "/api/device/msteamsonline/Number/?skip=0&limit=3&order_by=Number&direction=asc&traversal=down"
},
"operations": [
"list"
],
"meta": {
"model_type": "device/msteamsonline/Number",
"summary_attrs": [
{
"name": "Number",
"title": "Number"
},
{
"name": "Numbertel",
"title": "Number Base"
},
{
"name": "Numberext",
"title": "Number Extension"
},
{
"name": "NumberType",
"title": "Number Type"
},
{
"name": "Assigned",
"title": "Assigned"
},
{
"name": "ActivationState",
"title": "Activation State"
},
{
"name": "PstnAssignmentStatus",
"title": "PSTN Assignment Status"
},
{
"name": "Capability",
"title": "Capabilities"
},
{
"name": "IsoCountryCode",
"title": "ISO Country Code"
},
{
"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",
"move",
"clone",
"export",
"export_bulkload_template",
"bulk_update_form",
"configuration_template",
"field_display_policy",
"help",
"migration",
"transform",
"tag",
"tag_version"
],
"schema_version": "2019.1",
"actions": [
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/msteamsonline/Number/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/Number",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/msteamsonline/Number/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/Number/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/device/msteamsonline/Number/+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/Number/+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/Number/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/msteamsonline/Number/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/device/msteamsonline/Number/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/msteamsonline/Number/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msteamsonline/Number/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msteamsonline/Number/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/device/msteamsonline/Number/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"resources": [
{
"data": {
"Numberext": "",
"LocationUpdateSupported": true,
"hierarchy": "6644e9bcf14dbdc7695d37d1",
"NumberType": "DirectRouting",
"Numbertel": "\\+18652200002",
"Number": "+18652200002",
"Capability": [
"ConferenceAssignment",
"VoiceApplicationAssignment",
"UserAssignment"
],
"Assigned": true,
"PstnAssignmentStatus": "UserAssigned",
"ActivationState": "Activated",
"AssignedPstnTargetId": "70591103-7414-41b1-aecc-1e38966f9701",
"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/Number",
"summary_attrs": [
{
"name": "Number",
"title": "Number"
},
{
"name": "Numbertel",
"title": "Number Base"
},
{
"name": "Numberext",
"title": "Number Extension"
},
{
"name": "NumberType",
"title": "Number Type"
},
{
"name": "Assigned",
"title": "Assigned"
},
{
"name": "ActivationState",
"title": "Activation State"
},
{
"name": "PstnAssignmentStatus",
"title": "PSTN Assignment Status"
},
{
"name": "Capability",
"title": "Capabilities"
},
{
"name": "IsoCountryCode",
"title": "ISO Country Code"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "+18652200002",
"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/Number/6644f779f14dbdc7695fca71/",
"pkid": "6644f779f14dbdc7695fca71"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89bd5affa931cce3863f9",
"6644e9bcf14dbdc7695d37d1",
"6644f779f14dbdc7695fca71"
],
"schema_version": "",
"actions": [
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/msteamsonline/Number/6644f779f14dbdc7695fca71/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/6644f779f14dbdc7695fca71/?model_type=device/msteamsonline/Number",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/msteamsonline/Number/6644f779f14dbdc7695fca71/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/device/msteamsonline/Number/6644f779f14dbdc7695fca71/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/device/msteamsonline/Number/6644f779f14dbdc7695fca71/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/msteamsonline/Number/6644f779f14dbdc7695fca71/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msteamsonline/Number/6644f779f14dbdc7695fca71/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msteamsonline/Number/6644f779f14dbdc7695fca71/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "6644f779f14dbdc7695fca71"
},
{
"data": {
"Numberext": "",
"LocationUpdateSupported": true,
"hierarchy": "6644e9bcf14dbdc7695d37d1",
"NumberType": "DirectRouting",
"Numbertel": "\\+18671100013",
"Number": "+18671100013",
"Capability": [
"ConferenceAssignment",
"VoiceApplicationAssignment",
"UserAssignment"
],
"Assigned": true,
"PstnAssignmentStatus": "UserAssigned",
"ActivationState": "Activated",
"AssignedPstnTargetId": "94341ae7-07f4-47a7-81fc-3536d8b094d5",
"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/Number",
"summary_attrs": [
{
"name": "Number",
"title": "Number"
},
{
"name": "Numbertel",
"title": "Number Base"
},
{
"name": "Numberext",
"title": "Number Extension"
},
{
"name": "NumberType",
"title": "Number Type"
},
{
"name": "Assigned",
"title": "Assigned"
},
{
"name": "ActivationState",
"title": "Activation State"
},
{
"name": "PstnAssignmentStatus",
"title": "PSTN Assignment Status"
},
{
"name": "Capability",
"title": "Capabilities"
},
{
"name": "IsoCountryCode",
"title": "ISO Country Code"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "+18671100013",
"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/Number/6644f778f14dbdc7695fca68/",
"pkid": "6644f778f14dbdc7695fca68"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89bd5affa931cce3863f9",
"6644e9bcf14dbdc7695d37d1",
"6644f778f14dbdc7695fca68"
],
"schema_version": "",
"actions": [
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/msteamsonline/Number/6644f778f14dbdc7695fca68/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/6644f778f14dbdc7695fca68/?model_type=device/msteamsonline/Number",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/msteamsonline/Number/6644f778f14dbdc7695fca68/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/device/msteamsonline/Number/6644f778f14dbdc7695fca68/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/device/msteamsonline/Number/6644f778f14dbdc7695fca68/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/msteamsonline/Number/6644f778f14dbdc7695fca68/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msteamsonline/Number/6644f778f14dbdc7695fca68/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msteamsonline/Number/6644f778f14dbdc7695fca68/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "6644f778f14dbdc7695fca68"
},
{
"data": {
"Numberext": "",
"LocationUpdateSupported": true,
"hierarchy": "6644e9bcf14dbdc7695d37d1",
"NumberType": "DirectRouting",
"Numbertel": "\\+18671100040",
"Number": "+18671100040",
"Capability": [
"ConferenceAssignment",
"VoiceApplicationAssignment",
"UserAssignment"
],
"Assigned": true,
"PstnAssignmentStatus": "UserAssigned",
"ActivationState": "Activated",
"AssignedPstnTargetId": "4484c7eb-0a4c-46e7-9e2d-fed9c368a825",
"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/Number",
"summary_attrs": [
{
"name": "Number",
"title": "Number"
},
{
"name": "Numbertel",
"title": "Number Base"
},
{
"name": "Numberext",
"title": "Number Extension"
},
{
"name": "NumberType",
"title": "Number Type"
},
{
"name": "Assigned",
"title": "Assigned"
},
{
"name": "ActivationState",
"title": "Activation State"
},
{
"name": "PstnAssignmentStatus",
"title": "PSTN Assignment Status"
},
{
"name": "Capability",
"title": "Capabilities"
},
{
"name": "IsoCountryCode",
"title": "ISO Country Code"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "+18671100040",
"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/Number/6644f77af14dbdc7695fca7a/",
"pkid": "6644f77af14dbdc7695fca7a"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89bd5affa931cce3863f9",
"6644e9bcf14dbdc7695d37d1",
"6644f77af14dbdc7695fca7a"
],
"schema_version": "",
"actions": [
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/msteamsonline/Number/6644f77af14dbdc7695fca7a/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/6644f77af14dbdc7695fca7a/?model_type=device/msteamsonline/Number",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/msteamsonline/Number/6644f77af14dbdc7695fca7a/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/device/msteamsonline/Number/6644f77af14dbdc7695fca7a/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/device/msteamsonline/Number/6644f77af14dbdc7695fca7a/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/msteamsonline/Number/6644f77af14dbdc7695fca7a/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msteamsonline/Number/6644f77af14dbdc7695fca7a/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msteamsonline/Number/6644f77af14dbdc7695fca7a/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "6644f77af14dbdc7695fca7a"
}
]
}
(Show the first instance)
{
"data": {
"Numberext": "",
"LocationUpdateSupported": true,
"hierarchy": "6644e9bcf14dbdc7695d37d1",
"NumberType": "DirectRouting",
"Numbertel": "\\+18652200002",
"Number": "+18652200002",
"Capability": [
"ConferenceAssignment",
"VoiceApplicationAssignment",
"UserAssignment"
],
"Assigned": true,
"PstnAssignmentStatus": "UserAssigned",
"ActivationState": "Activated",
"AssignedPstnTargetId": "70591103-7414-41b1-aecc-1e38966f9701"
},
"meta": {
"model_type": "device/msteamsonline/Number",
"summary_attrs": [
{
"name": "Number",
"title": "Number"
},
{
"name": "Numbertel",
"title": "Number Base"
},
{
"name": "Numberext",
"title": "Number Extension"
},
{
"name": "NumberType",
"title": "Number Type"
},
{
"name": "Assigned",
"title": "Assigned"
},
{
"name": "ActivationState",
"title": "Activation State"
},
{
"name": "PstnAssignmentStatus",
"title": "PSTN Assignment Status"
},
{
"name": "Capability",
"title": "Capabilities"
},
{
"name": "IsoCountryCode",
"title": "ISO Country Code"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "+18652200002",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/MSTeamsOnline/6644f420f14dbdc7695ec116",
"pkid": "6644f420f14dbdc7695ec116"
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/6644e9bcf14dbdc7695d37d1",
"pkid": "6644e9bcf14dbdc7695d37d1"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/device/msteamsonline/Number/6644f779f14dbdc7695fca71/",
"pkid": "6644f779f14dbdc7695fca71"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89bd5affa931cce3863f9",
"6644e9bcf14dbdc7695d37d1",
"6644f779f14dbdc7695fca71"
],
"schema_version": "",
"actions": [
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/msteamsonline/Number/6644f779f14dbdc7695fca71/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/6644f779f14dbdc7695fca71/?hierarchy=[hierarchy]&model_type=device/msteamsonline/Number",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/msteamsonline/Number/6644f779f14dbdc7695fca71/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/Number/6644f779f14dbdc7695fca71/+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/Number/6644f779f14dbdc7695fca71/+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/Number/6644f779f14dbdc7695fca71/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msteamsonline/Number/6644f779f14dbdc7695fca71/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msteamsonline/Number/6644f779f14dbdc7695fca71/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"pkid": "6644f779f14dbdc7695fca71"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/msteamsonline/Number. | GET | /api/device/msteamsonline/Number/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/msteamsonline/Number as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/msteamsonline/Number/purge/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/device/msteamsonline/Number/transform/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/msteamsonline/Number/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/msteamsonline/Number/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/msteamsonline/Number | 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/Number; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/msteamsonline/Number/[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/Number and the JSON format can be used to import instances of device/msteamsonline/Number.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msteamsonline/Number/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/msteamsonline/Number/[pkid] | hierarchy=[hierarchy] | The device/msteamsonline/Number instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/msteamsonline/Number/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/msteamsonline/Number. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/msteamsonline/Number/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |