[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": {
"username": {
"required": true,
"type": "string",
"title": "Username"
},
"lookUpForUser": {
"default": true,
"type": "boolean",
"description": "Includes users above site level when searching",
"title": "Include users at higher hierarchy"
},
"first_name": {
"required": false,
"type": "string",
"title": "First name"
},
"last_name": {
"required": false,
"type": "string",
"title": "Last name"
},
"email": {
"format": "email",
"pattern": "^([^.@]+)(\\.[^.@]+)*@([^.@]+\\.)+([^.@]+)$",
"required": false,
"title": "Email address",
"type": "string"
},
"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"
},
"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"
},
"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"
},
"department": {
"required": false,
"type": "string",
"title": "Department"
},
"title": {
"required": false,
"type": "string",
"title": "Title"
},
"phone_number": {
"required": false,
"type": "string",
"title": "Phone number"
},
"mobile_phone": {
"required": false,
"type": "string",
"title": "Mobile phone"
},
"feature_type": {
"required": false,
"type": "string",
"title": "Feature type"
},
"line_uri": {
"required": false,
"type": "string",
"title": "Line URI"
},
"enable_line_uri": {
"required": false,
"type": "string",
"title": "Enable Line URI"
},
"automatic_line": {
"type": "boolean",
"description": "Use the next available line from the inventory.",
"title": "Use next available line"
},
"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"
},
"current_calling_line_identity": {
"required": false,
"type": "string",
"title": "Current Calling line identity"
},
"calling_line_identity": {
"required": false,
"type": "string",
"title": "Calling line identity"
},
"current_online_voice_routing_policy": {
"required": false,
"type": "string",
"title": "Current Online voice routing policy"
},
"online_voice_routing_policy": {
"required": false,
"type": "string",
"title": "Online voice routing policy"
},
"current_tenant_dial_plan": {
"required": false,
"type": "string",
"title": "Current Tenant dial plan"
},
"tenant_dial_plan": {
"required": false,
"type": "string",
"title": "Tenant dial plan"
},
"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": []
},
"msteams_user_status": {
"type": "string",
"title": "User status"
},
"mvs_hybrid_status_message": {
"type": "string",
"title": "Hybrid Status Message"
},
"mvs_hybrid_status": {
"type": "boolean",
"title": "Hybrid Status"
},
"msteams_user_exist": {
"type": "boolean",
"title": "msteams_user_exist"
},
"msteams_staging_user_exist": {
"type": "boolean",
"title": "msteams_staging_user_exist"
},
"custom_string_1": {
"type": "string",
"description": "Custom String",
"title": "Custom String 1"
},
"custom_string_2": {
"type": "string",
"description": "Custom String",
"title": "Custom String 2"
},
"custom_string_3": {
"type": "string",
"description": "Custom String",
"title": "Custom String 3"
},
"custom_string_4": {
"type": "string",
"description": "Custom String",
"title": "Custom String 4"
},
"custom_string_5": {
"type": "string",
"description": "Custom String",
"title": "Custom String 5"
},
"custom_string_6": {
"type": "string",
"description": "Custom String",
"title": "Custom String 6"
},
"custom_string_7": {
"type": "string",
"description": "Custom String",
"title": "Custom String 7"
},
"custom_string_8": {
"type": "string",
"description": "Custom String",
"title": "Custom String 8"
},
"custom_string_9": {
"type": "string",
"description": "Custom String",
"title": "Custom String 9"
},
"custom_string_10": {
"type": "string",
"description": "Custom String",
"title": "Custom String 10"
},
"custom_boolean_1": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 1"
},
"custom_boolean_2": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 2"
},
"custom_boolean_3": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 3"
},
"custom_boolean_4": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 4"
},
"custom_boolean_5": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 5"
},
"custom_boolean_6": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 6"
},
"custom_boolean_7": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 7"
},
"custom_boolean_8": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 8"
},
"custom_boolean_9": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 9"
},
"custom_boolean_10": {
"type": "boolean",
"description": "Custom Boolean",
"title": "Custom Boolean 10"
}
},
"schema_version": "4.4.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)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": null,
"direction": "asc",
"current": "/api/view/MicrosoftSubscriberQas/?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/MicrosoftSubscriberQas",
"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": "4.4.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/view/MicrosoftSubscriberQas/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/view/MicrosoftSubscriberQas/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/view/MicrosoftSubscriberQas/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/view/MicrosoftSubscriberQas/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"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. |