[Index]
Model ref.: view/QuickSubscriberForMsTeams
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": {
"username": {
"required": true,
"type": "string",
"title": "Username"
},
"lookUpForUser": {
"type": "boolean",
"description": "Includes users above site level when searching",
"title": "Include users at higher hierarchy"
},
"failIfNotFound": {
"type": "boolean",
"description": "used with API to prevent creation of local users where LDAP is in use",
"title": "Fail Transaction if user not found"
},
"entitlement_profile": {
"required": false,
"type": "string",
"title": "Entitlement Profile"
},
"firstname": {
"required": false,
"type": "string",
"title": "First Name"
},
"lastname": {
"required": true,
"type": "string",
"title": "Last Name"
},
"email": {
"format": "email",
"pattern": "^([^.@]+)(\\.[^.@]+)*@([^.@]+\\.)+([^.@]+)$",
"required": false,
"title": "Email Address",
"type": "string"
},
"password": {
"is_password": true,
"description": "The corresponding CUCM, CUC and WebEx user password will be set with this password",
"title": "Password",
"required": false,
"type": "string"
},
"pin": {
"is_password": true,
"description": "The corresponding CUCM and CUC user PIN will be set with this PIN",
"title": "PIN",
"required": false,
"type": "string"
},
"manager": {
"required": false,
"type": "string",
"title": "Manager"
},
"department": {
"required": false,
"type": "string",
"title": "Department"
},
"telephoneNumber": {
"required": false,
"type": "string",
"title": "Telephone Number"
},
"title": {
"required": false,
"type": "string",
"title": "Title"
},
"homeNumber": {
"required": false,
"type": "string",
"title": "Home Number"
},
"mobileNumber": {
"required": false,
"type": "string",
"title": "User's Mobile Number"
},
"directoryUri": {
"required": false,
"type": "string",
"title": "Directory URI"
},
"qagroup_name": {
"target": "/api/data/QuickAddGroups/choices/?field=group_name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": true,
"target_attr": "group_name",
"title": "Quick Add Group",
"type": "string",
"target_model_type": "data/QuickAddGroups",
"choices": []
},
"device_pool": {
"required": false,
"type": "string",
"title": "Device Pools"
},
"class_of_service": {
"required": false,
"type": "string",
"description": "Select to apply CSS's to lines and devices as defined in the selected Class of Service definition.",
"title": "Class of Service"
},
"existing": {
"type": "object",
"title": "Existing Services",
"properties": {
"phones": {
"type": "string",
"title": "Phones"
},
"ext_mobilities": {
"type": "string",
"title": "Extension Mobility Profiles"
},
"voicemail": {
"type": "string",
"title": "Voicemail Extension"
},
"webex": {
"type": "string",
"title": "WebEx"
},
"snr": {
"type": "string",
"title": "Single Number Reach"
},
"spark": {
"type": "string",
"title": "Webex App"
},
"contact_center": {
"type": "string",
"title": "Contact Center"
},
"teams_licenses": {
"items": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"title": "Name"
},
"AccountSkuId": {
"type": "string",
"title": "AccountSkuId"
}
}
},
"type": "array",
"title": "Teams Licenses"
},
"teams_line_uri": {
"type": "string",
"title": "Teams Line URI"
}
}
},
"user_status": {
"type": "string",
"title": "User status"
},
"lines": {
"items": {
"type": "object",
"properties": {
"line_filter": {
"title": "Inventory Filter",
"default": "Default",
"required": false,
"choices": [
{
"value": "default",
"title": "Default"
},
{
"value": "lines_e164_unused_local",
"title": "Show Unused Numbers with Associated E164's (Site Only)"
},
{
"value": "lines_e164_unused",
"title": "Show Unused Numbers with Associated E164's"
},
{
"value": "lines_used_only_local",
"title": "Show Used Numbers (Site Only)"
},
{
"value": "lines_used_only",
"title": "Show Used Numbers"
},
{
"value": "lines_userid_used",
"title": "Show Numbers belonging to this Subscriber"
}
],
"type": "string"
},
"directory_number": {
"type": "string",
"title": "Directory Number"
}
}
},
"required": false,
"type": "array",
"title": "Lines"
},
"voice": {
"type": "boolean",
"title": "Voice"
},
"phones": {
"items": {
"type": "object",
"properties": {
"phone_name": {
"description": "Name of phone to provision for e.g. SEPABCDEFABCDEF",
"format": "uri",
"title": "Phone Name",
"target_attr": "name",
"type": "string",
"target": "/api/device/cucm/Phone/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Phone",
"choices": []
}
}
},
"type": "array",
"title": "Phones"
},
"ms_teams": {
"type": "boolean",
"title": "Microsoft Teams"
},
"usage_location": {
"description": "Location used for Microsoft Licensing",
"title": "Usage Location",
"required": false,
"readonly": true,
"type": "string"
},
"mobility": {
"type": "boolean",
"title": "Extension Mobility"
},
"voicemail": {
"type": "boolean",
"title": "Voicemail"
},
"webex": {
"type": "boolean",
"title": "WebEx"
},
"snr": {
"type": "boolean",
"title": "Single Number Reach"
},
"spark": {
"type": "boolean",
"title": "Webex App"
},
"spark_template": {
"type": "string",
"title": "Webex App Template"
},
"contact_center": {
"type": "boolean",
"title": "Contact Center Agent"
},
"contact_center_profile": {
"type": "string",
"title": "Agent Profile"
},
"contact_center_extension": {
"type": "string",
"title": "Agent Extension"
},
"contact_center_device_type": {
"default": "Phone",
"choices": [
{
"value": "Phone",
"title": "Phone"
},
{
"value": "Extension Mobility",
"title": "Extension Mobility"
}
],
"type": "string",
"title": "Agent Device Type"
},
"contact_center_device": {
"type": "string",
"title": "Agent Device"
},
"emcc": {
"type": "boolean",
"title": "EMCC"
},
"mobile_number": {
"required": false,
"type": "string",
"title": "SNR Mobile Number"
},
"jabber": {
"type": "boolean",
"description": "When adding a Jabber device also specify a line to be associated. The first line specified will be used for any Jabber device added here.",
"title": "Jabber / Dual-Mode Device"
},
"jabber_agent": {
"choices": [
{
"value": "android",
"title": "Android"
},
{
"value": "csf",
"title": "CSF"
},
{
"value": "ipad",
"title": "iPad"
},
{
"value": "iphone",
"title": "iPhone"
}
],
"type": "string",
"title": "Jabber Agent"
},
"jabber_devices": {
"items": {
"type": "object",
"properties": {
"jabber_agent": {
"choices": [
{
"value": "android",
"title": "Android"
},
{
"value": "csf",
"title": "CSF"
},
{
"value": "ipad",
"title": "iPad"
},
{
"value": "iphone",
"title": "iPhone"
},
{
"value": "cim",
"title": "Carrier Integrated Mobile"
},
{
"value": "ctird",
"title": "CTI Remote Device"
}
],
"type": "string",
"title": "Jabber / Dual-Mode Agent"
},
"device_name": {
"type": "string",
"title": "Device Name"
},
"mobile_identity": {
"type": "boolean",
"title": "Mobile Identity"
},
"mobile_identity_destination": {
"type": "string",
"title": "Destination"
}
}
},
"type": "array",
"title": "Jabber and Dual-Mode Devices"
},
"self_service_id": {
"type": "boolean",
"title": "Enable Self Provisioning"
},
"self_provisioning_profile": {
"required": false,
"type": "string",
"title": "Self Provisioning User Profile"
},
"ldap_user": {
"type": "string",
"title": "LDAP User"
},
"normalized_user": {
"type": "string",
"title": "Normalized User"
},
"cucm_user": {
"type": "string",
"title": "CUCM User"
},
"msol_user": {
"type": "string",
"title": "MSOL User"
},
"csonline_user": {
"type": "string",
"title": "CS Online User"
},
"cucm_user_ldapDirectoryName": {
"type": "string",
"title": "CUCM User LDAP Directory Name"
},
"phone_template": {
"type": "string",
"title": "Phone Template"
},
"phone_type": {
"type": "string",
"title": "Phone Type"
},
"phone_protocol": {
"type": "string",
"title": "Phone Protocol"
},
"button_template": {
"type": "string",
"title": "Phone Button Template"
},
"security_profile": {
"type": "string",
"title": "Phone Security Profile"
},
"does_phonetype_support_pac": {
"type": "boolean",
"title": "does_phonetype_support_pac"
},
"enable_activation_code": {
"type": "boolean",
"description": "Enabling this checbox will instruct this workflow to add one phone only, using the Activation-Code based registration method. The code will be automatically generated. When selected, the Phone name field also gets hidden because the phone name will be automatically generated when this onboarding method is used.",
"title": "Use Activation Code Onboarding"
},
"phonetype_entitled": {
"type": "string",
"title": "Is PhoneType Entitled?"
},
"external_trigger": {
"type": "string",
"title": "External Auto Trigger?"
},
"custom_string_1": {
"type": "string",
"title": "custom_string_1"
},
"custom_string_2": {
"type": "string",
"title": "custom_string_2"
},
"custom_string_3": {
"type": "string",
"title": "custom_string_3"
},
"custom_string_4": {
"type": "string",
"title": "custom_string_4"
},
"custom_string_5": {
"type": "string",
"title": "custom_string_5"
},
"custom_string_6": {
"type": "string",
"title": "custom_string_6"
},
"custom_string_7": {
"type": "string",
"title": "custom_string_7"
},
"custom_string_8": {
"type": "string",
"title": "custom_string_8"
},
"custom_string_9": {
"type": "string",
"title": "custom_string_9"
},
"custom_string_10": {
"type": "string",
"title": "custom_string_10"
},
"custom_boolean_1": {
"type": "boolean",
"title": "custom_boolean_1"
},
"custom_boolean_2": {
"type": "boolean",
"title": "custom_boolean_2"
},
"custom_boolean_3": {
"type": "boolean",
"title": "custom_boolean_3"
},
"custom_boolean_4": {
"type": "boolean",
"title": "custom_boolean_4"
},
"custom_boolean_5": {
"type": "boolean",
"title": "custom_boolean_5"
},
"custom_boolean_6": {
"type": "boolean",
"title": "custom_boolean_6"
},
"custom_boolean_7": {
"type": "boolean",
"title": "custom_boolean_7"
},
"custom_boolean_8": {
"type": "boolean",
"title": "custom_boolean_8"
},
"custom_boolean_9": {
"type": "boolean",
"title": "custom_boolean_9"
},
"custom_boolean_10": {
"type": "boolean",
"title": "custom_boolean_10"
}
},
"schema_version": "2.0.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/QuickSubscriberForMsTeams/add/ |
|
The GUI Add form of view/QuickSubscriberForMsTeams 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/view/QuickSubscriberForMsTeams | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]shows the View resource has no instance pkid, because a view model stores no instances.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for view/QuickSubscriberForMsTeams | POST | /api/view/QuickSubscriberForMsTeams/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/QuickSubscriberForMsTeams/ |
|
The view/QuickSubscriberForMsTeams schema and all instances as JSON. |
(The list will return 0 to 3 view/QuickSubscriberForMsTeams instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": null,
"direction": "asc",
"current": "/api/view/QuickSubscriberForMsTeams/?skip=0&limit=3&order_by=None&direction=asc&traversal=down"
},
"operations": [
"add",
"help",
"configuration_template",
"field_display_policy",
"export_bulkload_template",
"transform"
],
"meta": {
"model_type": "view/QuickSubscriberForMsTeams",
"summary_attrs": [
{
"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": [
"add"
],
"schema_version": "2.0.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/view/QuickSubscriberForMsTeams/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/view/QuickSubscriberForMsTeams/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/view/QuickSubscriberForMsTeams/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/view/QuickSubscriberForMsTeams/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for view/QuickSubscriberForMsTeams. | GET | /api/view/QuickSubscriberForMsTeams/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/QuickSubscriberForMsTeams as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/QuickSubscriberForMsTeams/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/QuickSubscriberForMsTeams. |