[Index]
Model ref.: view/MicrosoftSubscriberQas
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": {
"phone_number": {
"required": false,
"type": "string",
"title": "Phone number"
},
"send_email_flag": {
"type": "boolean",
"description": "Send Email to user using predefined HTML Email Template. Email template used is 'Quick Add Subscriber'",
"title": "Send Email to user flag"
},
"current_tenant_dial_plan": {
"required": false,
"type": "string",
"title": "Current Tenant dial plan"
},
"custom_boolean_10": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 10"
},
"custom_string_4": {
"type": "string",
"description": "Custom String",
"title": "Custom String 4"
},
"automatic_line": {
"type": "boolean",
"description": "Use the next available line from the inventory.",
"title": "Use next available line"
},
"send_email": {
"type": "boolean",
"description": "Send Email to user using predefined HTML Email Template. Email template used is 'Quick Add Subscriber'. To enable email feature set 'Allow welcome email to be sent to user after Quick Add Subscriber' in Global Settings.",
"title": "Send welcome email"
},
"last_name": {
"required": false,
"type": "string",
"title": "Last name"
},
"current_calling_line_identity": {
"required": false,
"type": "string",
"title": "Current Calling line identity"
},
"msteams_user_exist": {
"type": "boolean",
"title": "msteams_user_exist"
},
"custom_string_6": {
"type": "string",
"description": "Custom String",
"title": "Custom String 6"
},
"custom_boolean_8": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 8"
},
"first_name": {
"required": false,
"type": "string",
"title": "First name"
},
"lookUpForUser": {
"default": true,
"type": "boolean",
"description": "Includes users above site level when searching",
"title": "Include users at higher hierarchy"
},
"feature_type": {
"required": false,
"type": "string",
"title": "Feature type"
},
"title": {
"required": false,
"type": "string",
"title": "Title"
},
"calling_line_identity": {
"required": false,
"type": "string",
"title": "Calling line identity"
},
"line_uri": {
"required": false,
"type": "string",
"title": "Line URI"
},
"department": {
"required": false,
"type": "string",
"title": "Department"
},
"email": {
"pattern": "^([^.@]+)(\\.[^.@]+)*@([^.@]+\\.)+([^.@]+)$",
"type": "string",
"format": "email",
"required": false,
"title": "Email address"
},
"username": {
"required": true,
"type": "string",
"title": "Username"
},
"mobile_phone": {
"required": false,
"type": "string",
"title": "Mobile phone"
},
"enable_line_uri": {
"required": false,
"type": "string",
"title": "Enable Line URI"
},
"msteams_staging_user_exist": {
"type": "boolean",
"title": "msteams_staging_user_exist"
},
"custom_string_10": {
"type": "string",
"description": "Custom String",
"title": "Custom String 10"
},
"current_online_voice_routing_policy": {
"required": false,
"type": "string",
"title": "Current Online voice routing policy"
},
"password": {
"required": false,
"is_password": true,
"type": "string",
"description": "The corresponding CUCM, CUC and WebEx user password will be set with this password",
"title": "Password"
},
"line_uri_type": {
"choices": [
{
"value": "DirectRouting",
"title": "Direct Routing"
},
{
"value": "CallingPlan",
"title": "Calling Plan"
},
{
"value": "OperatorConnect",
"title": "Operator Connect"
}
],
"required": false,
"type": "string",
"title": "Line URI type"
},
"custom_string_9": {
"type": "string",
"description": "Custom String",
"title": "Custom String 9"
},
"custom_string_8": {
"type": "string",
"description": "Custom String",
"title": "Custom String 8"
},
"custom_string_1": {
"type": "string",
"description": "Custom String",
"title": "Custom String 1"
},
"msteams_user_status": {
"type": "string",
"title": "User status"
},
"custom_string_2": {
"type": "string",
"description": "Custom String",
"title": "Custom String 2"
},
"custom_string_5": {
"type": "string",
"description": "Custom String",
"title": "Custom String 5"
},
"tenant_dial_plan": {
"required": false,
"type": "string",
"title": "Tenant dial plan"
},
"custom_string_7": {
"type": "string",
"description": "Custom String",
"title": "Custom String 7"
},
"qagroup_name": {
"target": "/api/data/QuickAddGroups/choices/?field=group_name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": true,
"choices": [],
"target_attr": "group_name",
"target_model_type": "data/QuickAddGroups",
"title": "Quick Add Group",
"type": "string"
},
"custom_boolean_5": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 5"
},
"custom_boolean_4": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 4"
},
"custom_boolean_7": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 7"
},
"custom_boolean_6": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 6"
},
"custom_boolean_1": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 1"
},
"custom_boolean_3": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 3"
},
"custom_boolean_2": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 2"
},
"online_voice_routing_policy": {
"required": false,
"type": "string",
"title": "Online voice routing policy"
},
"custom_boolean_9": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 9"
},
"custom_string_3": {
"type": "string",
"description": "Custom String",
"title": "Custom String 3"
}
},
"schema_version": "4.3.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/MicrosoftSubscriberQas/add/ |
|
The GUI Add form of view/MicrosoftSubscriberQas 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/MicrosoftSubscriberQas/ | 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/MicrosoftSubscriberQas | POST | /api/view/MicrosoftSubscriberQas/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/MicrosoftSubscriberQas/ |
|
The view/MicrosoftSubscriberQas schema and all instances as JSON. |
(The list will return 0 to 3 view/MicrosoftSubscriberQas instances)
{
"operations": [
"add",
"help",
"configuration_template",
"field_display_policy",
"export_bulkload_template",
"transform"
],
"pagination": {
"direction": "asc",
"order_by": null,
"maximum_limit": 2000,
"skip": 0,
"current": "/api/view/MicrosoftSubscriberQas/?skip=0&limit=3&order_by=None&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "4.3.0",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/view/MicrosoftSubscriberQas/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/view/MicrosoftSubscriberQas/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/view/MicrosoftSubscriberQas/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/view/MicrosoftSubscriberQas/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "view/MicrosoftSubscriberQas",
"model_specific_actions": [
"add"
],
"summary_attrs": [
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for view/MicrosoftSubscriberQas. | GET | /api/view/MicrosoftSubscriberQas/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/MicrosoftSubscriberQas as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/MicrosoftSubscriberQas/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/MicrosoftSubscriberQas. |