[Index]
Model ref.: device/msoperatorconnect/TnUploadToAccountV2
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": {
"Id": {
"name": "Id",
"type": "string",
"title": "Id"
},
"AllowTenantAddressUpdate": {
"name": "AllowTenantAddressUpdate",
"type": "boolean",
"description": "",
"title": "Allow Tenant Address Update"
},
"AcquiredOn": {
"name": "AcquiredOn",
"type": "string",
"title": "Acquired On"
},
"CallingProfileId": {
"format": "uri",
"target": "/api/device/msoperatorconnect/CallingProfilesV2/choices/?choice_title=Name&field=Id&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Id",
"target_title": "Name",
"convert_to_primary_key": true,
"name": "CallingProfileId",
"type": "string",
"title": "Calling Profile",
"target_model_type": "device/msoperatorconnect/CallingProfilesV2",
"choices": []
},
"ChoosableCapabilities": {
"name": "ChoosableCapabilities",
"type": "array",
"description": "",
"title": "Choosable Capabilities",
"items": {
"type": "string",
"choices": [
{
"value": "Office365",
"title": "Office 365"
},
{
"value": "UserAssignment",
"title": "User Assignment"
},
{
"value": "InboundCalling",
"title": "Inbound Calling"
},
{
"value": "OutboundCalling",
"title": "Outbound Calling"
},
{
"value": "Mobile",
"title": "Mobile"
}
]
}
},
"CivicAddressId": {
"name": "CivicAddressId",
"type": "string",
"title": "CivicAddressId"
},
"CreatedAt": {
"name": "CreatedAt",
"type": "string",
"title": "Created At"
},
"CreatedBy": {
"name": "CreatedBy",
"type": "string",
"title": "Created By"
},
"DisplayedCountryCode": {
"name": "DisplayedCountryCode",
"type": "string",
"title": "Displayed Country Code",
"description": "Country code, eg. US",
"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 Id"
},
"TnUploadEntries": {
"name": "TnUploadEntries",
"type": "array",
"description": "",
"title": "Tn Upload Entries",
"items": {
"type": "object",
"properties": {
"TelephoneNumber": {
"type": "string",
"name": "TelephoneNumber",
"description": "",
"title": "Telephone Number"
},
"Status": {
"name": "Status",
"description": "",
"type": "string",
"title": "Status"
},
"LocationId": {
"name": "LocationId",
"type": "string",
"description": "",
"title": "Location Id"
},
"DisplayedCountryCode": {
"name": "DisplayedCountryCode",
"description": "",
"type": "string",
"title": "Displayed Country Code"
},
"AllowTenantAddressUpdate": {
"name": "AllowTenantAddressUpdate",
"type": "boolean",
"description": "",
"title": "Allow Tenant Address Update"
},
"AcquiredCapabilities": {
"name": "AcquiredCapabilities",
"type": "array",
"title": "Acquired Capabilities",
"readonly": true,
"items": {
"type": "string"
}
}
}
}
},
"ProductContext": {
"name": "ProductContext",
"type": "string",
"title": "Product Context",
"default": "teams"
},
"Status": {
"name": "Status",
"type": "string",
"title": "Status"
},
"TelephoneNumbers": {
"name": "TelephoneNumbers",
"type": "array",
"title": "Telephone Numbers",
"items": {
"type": "string"
}
},
"TenantId": {
"format": "uri",
"target": "/api/device/msoperatorconnect/PartnerOperatorConsents/choices/?choice_title=TenantId&field=TenantId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "TenantId",
"target_title": "TenantId",
"convert_to_primary_key": true,
"name": "TenantId",
"type": "string",
"title": "Tenant Id",
"target_model_type": "device/msoperatorconnect/PartnerOperatorConsents",
"choices": []
},
"TicketId": {
"name": "TicketId",
"type": "string",
"title": "Ticket Id"
},
"Usage": {
"name": "Usage",
"type": "string",
"title": "Usage"
}
},
"schema_version": "1.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/msoperatorconnect/TnUploadToAccountV2/add/ |
|
The GUI Add form of device/msoperatorconnect/TnUploadToAccountV2 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/msoperatorconnect/TnUploadToAccountV2 | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/msoperatorconnect/TnUploadToAccountV2/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/msoperatorconnect/TnUploadToAccountV2/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/msoperatorconnect/TnUploadToAccountV2/[pkid1]", "/api/v0/device/msoperatorconnect/TnUploadToAccountV2/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/msoperatorconnect/TnUploadToAccountV2/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/msoperatorconnect/TnUploadToAccountV2 |
|
{"hrefs": ["/api/device/msoperatorconnect/TnUploadToAccountV2/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/msoperatorconnect/TnUploadToAccountV2 |
|
{"hrefs": ["/api/device/msoperatorconnect/TnUploadToAccountV2/[pkid1]", "/api/device/msoperatorconnect/TnUploadToAccountV2/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/msoperatorconnect/TnUploadToAccountV2; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/msoperatorconnect/TnUploadToAccountV2/export/ |
|
{ "hrefs":["/api/device/msoperatorconnect/TnUploadToAccountV2/[pkid1]", "/api/device/msoperatorconnect/TnUploadToAccountV2/[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/msoperatorconnect/TnUploadToAccountV2 and the JSON format can be used to import instances of device/msoperatorconnect/TnUploadToAccountV2.
GET http://[host-proxy]/api/device/msoperatorconnect/TnUploadToAccountV2/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/msoperatorconnect/TnUploadToAccountV2 | POST | /api/device/msoperatorconnect/TnUploadToAccountV2/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msoperatorconnect/TnUploadToAccountV2/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/device/msoperatorconnect/TnUploadToAccountV2/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/msoperatorconnect/TnUploadToAccountV2/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/msoperatorconnect/TnUploadToAccountV2/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/device/msoperatorconnect/TnUploadToAccountV2/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/msoperatorconnect/TnUploadToAccountV2/ |
|
The device/msoperatorconnect/TnUploadToAccountV2 schema and all instances as JSON. |
(The list will return 0 to 3 device/msoperatorconnect/TnUploadToAccountV2 instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "Id",
"direction": "asc",
"current": "/api/device/msoperatorconnect/TnUploadToAccountV2/?skip=0&limit=3&order_by=Id&direction=asc&traversal=down"
},
"operations": [
"list"
],
"meta": {
"model_type": "device/msoperatorconnect/TnUploadToAccountV2",
"summary_attrs": [
{
"name": "Id",
"title": "Id"
},
{
"name": "TenantId",
"title": "Tenant Id"
},
{
"name": "CreatedAt",
"title": "Created At"
},
{
"name": "CreatedBy",
"title": "Created By"
},
{
"name": "ProductContext",
"title": "Product Context"
},
{
"name": "Status",
"title": "Status"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"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",
"move",
"export",
"export_bulkload_template",
"bulk_update_form",
"configuration_template",
"field_display_policy",
"help",
"migration",
"transform",
"tag",
"tag_version"
],
"schema_version": "1.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/device/msoperatorconnect/TnUploadToAccountV2/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/msoperatorconnect/TnUploadToAccountV2/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/msoperatorconnect/TnUploadToAccountV2",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/msoperatorconnect/TnUploadToAccountV2/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/msoperatorconnect/TnUploadToAccountV2/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/device/msoperatorconnect/TnUploadToAccountV2/+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/msoperatorconnect/TnUploadToAccountV2/+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/msoperatorconnect/TnUploadToAccountV2/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/msoperatorconnect/TnUploadToAccountV2/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/device/msoperatorconnect/TnUploadToAccountV2/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/msoperatorconnect/TnUploadToAccountV2/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/msoperatorconnect/TnUploadToAccountV2/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/msoperatorconnect/TnUploadToAccountV2/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/device/msoperatorconnect/TnUploadToAccountV2/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/msoperatorconnect/TnUploadToAccountV2. | GET | /api/device/msoperatorconnect/TnUploadToAccountV2/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/msoperatorconnect/TnUploadToAccountV2 as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/msoperatorconnect/TnUploadToAccountV2/purge/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/device/msoperatorconnect/TnUploadToAccountV2/transform/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/msoperatorconnect/TnUploadToAccountV2 | 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/msoperatorconnect/TnUploadToAccountV2; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/msoperatorconnect/TnUploadToAccountV2/[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/msoperatorconnect/TnUploadToAccountV2 and the JSON format can be used to import instances of device/msoperatorconnect/TnUploadToAccountV2.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/msoperatorconnect/TnUploadToAccountV2/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/msoperatorconnect/TnUploadToAccountV2/[pkid] | hierarchy=[hierarchy] | The device/msoperatorconnect/TnUploadToAccountV2 instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/msoperatorconnect/TnUploadToAccountV2/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/msoperatorconnect/TnUploadToAccountV2. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/msoperatorconnect/TnUploadToAccountV2/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |