[Index]
MS Quick Add Groups =================== Microsoft Quick Add Groups -------------------------- The settings defined in the configuration templates (e.g. Skype for Business User) specified in the Quick Add Group are used to determine the configuration of the corresponding service (e.g. the settings of the Skype for Business user). The actual settings provisioned for the user is a combination of the Quick Add Group of the user and the MS defaults for the site as explained below. Whilst Quick Add Groups define the settings for each use type, Lync/Microsoft Default settings ensure that the Quick Add Subscriber automation templates apply settings appropriate to the type of user. When adding a subscriber using the Quick Add Subscriber automation template, the Quick Add Groups are applied once the Lync/Microsoft details are applied. The settings that are applied to Microsoft Lync / Skype for Business users can be defined: * By Lync/Microsoft Defaults instances at a higher level of the VOSS hierarchy (e.g. customer) level, * Overridden [#f1]_ with Lync/Microsoft Defaults instances at a lower level (e.g. country, site, department, etc depending on how the hierarchy has been configured), or * Specified by Quick Add Groups selected in Quick Add Subscriber templates. Selecting Microsoft Licenses ---------------------------- In order to allocate the correct Office 365 features applicable in the country of the user who is consuming the license, specify the default Usage Location (country) used for the site. If it is not specified, the setting from MS defaults will be used. The Office 365 Licenses allocated to the user during the Quick Add Subscriber on-boarding process is specified by the License settings in the Quick Add Group allocated to the user. The service plans for Skype for Business Online, Exchange Online and other MS online services can be specified in order to ensure that only the necessary service plans are enabled/disabled during migration of Skype for Business and Exchange users or on-boarding of users: * Skype for Business Service Plans enabled in the selected Quick Add Group will be enabled if the user is given Skype for Business Online Services. * Exchange Service Plans enabled in the selected Quick Add Group will be enabled if the user is given an online voicemail box. * Other service plans enabled in the Quick Add Group selected will be enabled if the user is given MS online services. .. |VOSS-4-UC| replace:: VOSS-4-UC .. [#f1] When a policy is defined in the Lync/Microsoft Defaults it will be overwritten if defined in an instance at site level or in the Quick Add Groups.
Model ref.: data/LyncQuickAddGroups-Teams
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": {
"group_name": {
"required": true,
"type": "string",
"title": "Group Name"
},
"default_webex_user_template": {
"type": "string",
"title": "Webex User Template"
},
"default_cucm_jabber_iphone_template": {
"type": "string",
"title": "Jabber iPhone Template"
},
"default_cucm_jabber_csf_template": {
"type": "string",
"title": "Jabber CSF Template"
},
"default_cucm_jabber_ipad_template": {
"type": "string",
"title": "Jabber iPad Template"
},
"default_cucm_jabber_android_template": {
"type": "string",
"title": "Jabber Android Template"
},
"default_cucm_jabber_cim_template": {
"type": "string",
"title": "Carrier Integrated Mobile Device Template"
},
"default_cucm_jabber_ctird_template": {
"type": "string",
"title": "CTI Remote Device Template"
},
"default_cucm_user_template": {
"type": "string",
"title": "CUCM User Template"
},
"default_cucm_phone_template": {
"type": "string",
"title": "Phone Template"
},
"default_cucm_line_template": {
"type": "string",
"title": "Line Template"
},
"default_cucm_device_profile_template": {
"type": "string",
"title": "Extension Mobility Template"
},
"default_cucm_rdp_template": {
"type": "string",
"title": "Remote Destination Profile Template"
},
"default_cucm_rd_template": {
"type": "string",
"title": "Remote Destination Template"
},
"default_cuc_user_template": {
"type": "string",
"title": "CUC User Template"
},
"default_cuc_user_pin_template": {
"type": "string",
"title": "CUC User PIN Template"
},
"default_cuc_user_password_template": {
"type": "string",
"title": "CUC User Password Template"
},
"default_lync_user_template": {
"type": "string",
"title": "Default SfB User Template"
},
"default_exchangehybrid_ummailbox_template": {
"type": "string",
"title": "Default Exchange UM Mailbox Template"
},
"default_exchangehybrid_mailbox_template": {
"type": "string",
"title": "Default Exchange Mailbox Template"
},
"office_365": {
"type": "object",
"description": "Description of the MS Online infrastructure supported at this site.",
"title": "Office 365",
"properties": {
"usage_location": {
"default": "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"
}
],
"type": "string",
"title": "Usage Location"
},
"Licenses": {
"items": {
"type": "object",
"properties": {
"AccountSkuId": {
"target": "/api/device/msonline/MsolAccountSku/choices/?field=SkuId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Product License",
"target_attr": "SkuId",
"type": "string",
"target_model_type": "device/msonline/MsolAccountSku",
"choices": []
},
"S4B_online_service_plans": {
"items": {
"type": "string"
},
"type": "array",
"title": "Skype for Business Online Service Plans"
},
"ms_teams_service_plans": {
"items": {
"type": "string"
},
"type": "array",
"title": "Microsoft Teams Service Plans"
},
"exchange_online_service_plans": {
"items": {
"type": "string"
},
"type": "array",
"title": "Exchange Online Service Plans"
},
"EnabledPlans": {
"items": {
"type": "string"
},
"type": "array",
"title": "Other Service Plans"
}
}
},
"type": "array",
"title": "Licenses"
}
}
},
"default_skypeforbusiness_online_template": {
"type": "string",
"title": "Default Skype for Business Online Template"
},
"default_exchangeonline_ummailbox_template": {
"type": "string",
"title": "Default Exchange Online UM Mailbox Template"
},
"default_exchangeonline_mailbox_template": {
"type": "string",
"title": "Default Exchange Online Mailbox Template"
},
"microsoft_teams": {
"type": "object",
"description": "Configure Policies for Microsoft teams",
"title": "Microsoft Teams",
"properties": {
"teams_client_config": {
"type": "string",
"title": "Teams Client Config"
},
"teams_calling_policy": {
"type": "string",
"title": "Teams Calling Policy"
},
"teams_meeting_policy": {
"type": "string",
"title": "Teams Meeting Policy"
},
"teams_messaging_policy": {
"type": "string",
"title": "Teams Messaging Policy"
},
"teams_meeting_broadcast_policy": {
"type": "string",
"title": "Teams Meeting Broadcast Policy"
},
"teams_callpark_policy": {
"type": "string",
"title": "Teams Call Park Policy"
},
"teams_upgrade_policy": {
"type": "string",
"title": "Teams Upgrade Policy"
}
}
}
},
"schema_version": "0.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/LyncQuickAddGroups-Teams/add/ |
|
The GUI Add form of data/LyncQuickAddGroups-Teams 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/data/LyncQuickAddGroups-Teams | 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/data/LyncQuickAddGroups-Teams/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/LyncQuickAddGroups-Teams/[pkid1]", "/api/data/LyncQuickAddGroups-Teams/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/LyncQuickAddGroups-Teams/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/LyncQuickAddGroups-Teams/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/LyncQuickAddGroups-Teams/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/LyncQuickAddGroups-Teams/[pkid1]", "/api/v0/data/LyncQuickAddGroups-Teams/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/LyncQuickAddGroups-Teams/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/LyncQuickAddGroups-Teams; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/LyncQuickAddGroups-Teams/export/ |
|
{ "hrefs":["/api/data/LyncQuickAddGroups-Teams/[pkid1]", "/api/data/LyncQuickAddGroups-Teams/[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 data/LyncQuickAddGroups-Teams and the JSON format can be used to import instances of data/LyncQuickAddGroups-Teams.
GET http://[host-proxy]/api/data/LyncQuickAddGroups-Teams/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/LyncQuickAddGroups-Teams | POST | /api/data/LyncQuickAddGroups-Teams/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/data/LyncQuickAddGroups-Teams/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/data/LyncQuickAddGroups-Teams/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/LyncQuickAddGroups-Teams/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/LyncQuickAddGroups-Teams/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/LyncQuickAddGroups-Teams/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/LyncQuickAddGroups-Teams/ |
|
The data/LyncQuickAddGroups-Teams schema and all instances as JSON. |
(The list will return 0 to 3 data/LyncQuickAddGroups-Teams instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "group_name",
"direction": "asc",
"current": "/api/data/LyncQuickAddGroups-Teams/?skip=0&limit=3&order_by=group_name&direction=asc&traversal=fulltree"
},
"operations": [
"field_display_policy",
"update",
"help",
"remove",
"move",
"add",
"export",
"list",
"configuration_template",
"get",
"bulk_update_form",
"migration",
"transform",
"export_bulkload_template"
],
"meta": {
"model_type": "data/LyncQuickAddGroups-Teams",
"summary_attrs": [
{
"name": "group_name",
"title": "Group Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "?",
"business_key": {
"hierarchy": true,
"unique": [
"group_name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"add",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"migration",
"remove",
"tag",
"tag_version",
"update"
],
"schema_version": "0.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/LyncQuickAddGroups-Teams/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/LyncQuickAddGroups-Teams/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/data/LyncQuickAddGroups-Teams/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/LyncQuickAddGroups-Teams/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/data/LyncQuickAddGroups-Teams/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/LyncQuickAddGroups-Teams/+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/data/LyncQuickAddGroups-Teams/+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/data/LyncQuickAddGroups-Teams/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/LyncQuickAddGroups-Teams/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/data/LyncQuickAddGroups-Teams/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/LyncQuickAddGroups-Teams/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/LyncQuickAddGroups-Teams/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/LyncQuickAddGroups-Teams. | GET | /api/data/LyncQuickAddGroups-Teams/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/LyncQuickAddGroups-Teams as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/LyncQuickAddGroups-Teams/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/LyncQuickAddGroups-Teams/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/LyncQuickAddGroups-Teams/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/LyncQuickAddGroups-Teams/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/LyncQuickAddGroups-Teams; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/LyncQuickAddGroups-Teams/[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 data/LyncQuickAddGroups-Teams and the JSON format can be used to import instances of data/LyncQuickAddGroups-Teams.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/LyncQuickAddGroups-Teams/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/LyncQuickAddGroups-Teams/[pkid] | hierarchy=[hierarchy] | The data/LyncQuickAddGroups-Teams instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/LyncQuickAddGroups-Teams/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/LyncQuickAddGroups-Teams. |