[Index]
Model ref.: view/QuickSubscriber
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": {
"custom_string_6": {
"type": "string",
"title": "custom_string_6"
},
"self_provisioning_profile": {
"required": false,
"type": "string",
"title": "Self Provisioning User Profile"
},
"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"
},
"directoryUri": {
"required": false,
"type": "string",
"title": "Directory URI"
},
"pin": {
"is_password": true,
"description": "The corresponding CUCM and CUC user PIN will be set with this PIN",
"title": "PIN",
"minLength": 1,
"required": false,
"maxLength": 24,
"pattern": "^[0-9]*$",
"type": "string"
},
"mobility": {
"type": "boolean",
"title": "Extension Mobility"
},
"homeNumber": {
"required": false,
"type": "string",
"title": "Home Number"
},
"lines": {
"items": {
"type": "object",
"properties": {
"line_filter": {
"default": "default",
"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"
}
],
"required": false,
"type": "string",
"title": "Inventory Filter"
},
"directory_number": {
"type": "string",
"title": "Directory Number"
}
}
},
"required": false,
"type": "array",
"title": "Lines"
},
"custom_boolean_1": {
"type": "boolean",
"title": "custom_boolean_1"
},
"existing": {
"type": "object",
"properties": {
"contact_center": {
"type": "string",
"title": "Contact Center"
},
"phones": {
"type": "string",
"title": "Phones"
},
"voicemail": {
"type": "string",
"title": "Voicemail Extension"
},
"ext_mobilities": {
"type": "string",
"title": "Extension Mobility Profiles"
},
"webex": {
"type": "string",
"title": "WebEx"
},
"snr": {
"type": "string",
"title": "Single Number Reach"
},
"spark": {
"type": "string",
"title": "Webex Teams"
}
},
"title": "Existing Services"
},
"custom_boolean_9": {
"type": "boolean",
"title": "custom_boolean_9"
},
"send_email": {
"type": "boolean",
"description": "Send Email to user using predefined HTML Email Template. Email template used is 'Quick Add Subscriber'",
"title": "Send welcome email"
},
"manager": {
"required": false,
"type": "string",
"title": "Manager"
},
"custom_string_2": {
"type": "string",
"title": "custom_string_2"
},
"cucm_user": {
"type": "string",
"title": "CUCM User"
},
"contact_center_profile": {
"type": "string",
"title": "Agent Profile"
},
"custom_boolean_8": {
"type": "boolean",
"title": "custom_boolean_8"
},
"user_status": {
"type": "string",
"title": "User status"
},
"lookUpForUser": {
"type": "boolean",
"description": "Includes users above site level when searching",
"title": "Include users at higher hierarchy"
},
"contact_center": {
"type": "boolean",
"title": "Contact Center Agent"
},
"title": {
"required": false,
"type": "string",
"title": "Title"
},
"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"
},
"entitlement_profile": {
"required": false,
"type": "string",
"title": "Entitlement Profile"
},
"emcc": {
"type": "boolean",
"title": "EMCC"
},
"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"
},
"webex": {
"type": "boolean",
"title": "WebEx"
},
"custom_string_5": {
"type": "string",
"title": "custom_string_5"
},
"phones": {
"items": {
"type": "object",
"properties": {
"phone_name": {
"target": "/api/device/cucm/Phone/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Phone Name",
"choices": [],
"target_attr": "name",
"target_model_type": "device/cucm/Phone",
"type": "string",
"description": "Name of phone to provision for e.g. SEPABCDEFABCDEF"
}
}
},
"type": "array",
"title": "Phones"
},
"department": {
"required": false,
"type": "string",
"title": "Department"
},
"cucm_user_ldapDirectoryName": {
"type": "string",
"title": "CUCM User LDAP Directory Name"
},
"jabber_agent": {
"choices": [
{
"value": "android",
"title": "Android"
},
{
"value": "csf",
"title": "CSF"
},
{
"value": "ipad",
"title": "iPad"
},
{
"value": "iphone",
"title": "iPhone"
}
],
"type": "string",
"title": "Jabber Agent"
},
"email": {
"pattern": "^([^.@]+)(\\.[^.@]+)*@([^.@]+\\.)+([^.@]+)$",
"type": "string",
"format": "email",
"required": false,
"title": "Email Address"
},
"username": {
"required": true,
"type": "string",
"title": "Username"
},
"custom_string_9": {
"type": "string",
"title": "custom_string_9"
},
"custom_boolean_4": {
"type": "boolean",
"title": "custom_boolean_4"
},
"phone_protocol": {
"type": "string",
"title": "Phone Protocol"
},
"firstname": {
"required": false,
"type": "string",
"title": "First Name"
},
"custom_string_8": {
"type": "string",
"title": "custom_string_8"
},
"lastname": {
"required": true,
"type": "string",
"title": "Last Name"
},
"phonetype_entitled": {
"type": "string",
"title": "Is PhoneType Entitled?"
},
"custom_boolean_10": {
"type": "boolean",
"title": "custom_boolean_10"
},
"does_phonetype_support_pac": {
"type": "boolean",
"title": "does_phonetype_support_pac"
},
"snr": {
"type": "boolean",
"title": "Single Number Reach"
},
"custom_string_10": {
"type": "string",
"title": "custom_string_10"
},
"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"
},
"mobile_number": {
"required": false,
"type": "string",
"title": "SNR Mobile Number"
},
"external_trigger": {
"type": "string",
"title": "External Auto Trigger?"
},
"spark": {
"type": "boolean",
"title": "Webex Teams"
},
"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"
},
"spark_template": {
"type": "string",
"title": "Webex Teams Template"
},
"ldap_user": {
"type": "string",
"title": "LDAP User"
},
"data_user": {
"type": "string",
"title": "Data User"
},
"telephoneNumber": {
"required": false,
"type": "string",
"title": "Telephone Number"
},
"mobileNumber": {
"required": false,
"type": "string",
"title": "User's Mobile Number"
},
"button_template": {
"type": "string",
"title": "Phone Button Template"
},
"phone_template": {
"type": "string",
"title": "Phone Template"
},
"contact_center_device": {
"type": "string",
"title": "Agent Device"
},
"contact_center_extension": {
"type": "string",
"title": "Agent Extension"
},
"apply_reserved_number_for_user": {
"type": "boolean",
"description": "If set to true, then workflow should attempt to find the matching INI number that was pre-reserved at some stage for this user (indicated by the INI-entry's 'reservation_notes' field having some value like 'userid:<USERNAME>').",
"title": "Auto-Select Pre-Reserved Number For User"
},
"custom_string_1": {
"type": "string",
"title": "custom_string_1"
},
"security_profile": {
"type": "string",
"title": "Phone Security Profile"
},
"voicemail": {
"type": "boolean",
"title": "Voicemail"
},
"phone_type": {
"type": "string",
"title": "Phone Type"
},
"device_pool": {
"required": false,
"type": "string",
"title": "Device Pools"
},
"custom_string_4": {
"type": "string",
"title": "custom_string_4"
},
"custom_string_7": {
"type": "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",
"title": "custom_boolean_5"
},
"self_service_id": {
"type": "boolean",
"title": "Enable Self Provisioning"
},
"custom_boolean_7": {
"type": "boolean",
"title": "custom_boolean_7"
},
"custom_boolean_6": {
"type": "boolean",
"title": "custom_boolean_6"
},
"jabber_devices": {
"items": {
"type": "object",
"properties": {
"mobile_identity_destination": {
"type": "string",
"title": "Destination"
},
"mobile_identity": {
"type": "boolean",
"title": "Mobile Identity"
},
"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"
}
}
},
"type": "array",
"title": "Jabber and Dual-Mode Devices"
},
"custom_boolean_3": {
"type": "boolean",
"title": "custom_boolean_3"
},
"custom_boolean_2": {
"type": "boolean",
"title": "custom_boolean_2"
},
"voice": {
"type": "boolean",
"title": "Voice"
},
"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"
},
"custom_string_3": {
"type": "string",
"title": "custom_string_3"
},
"contact_center_device_type": {
"default": "Phone",
"choices": [
{
"value": "Phone",
"title": "Phone"
},
{
"value": "Extension Mobility",
"title": "Extension Mobility"
}
],
"type": "string",
"title": "Agent Device Type"
}
},
"schema_version": "4.0.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/QuickSubscriber/add/ |
|
The GUI Add form of view/QuickSubscriber 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/QuickSubscriber/ | 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/QuickSubscriber | POST | /api/view/QuickSubscriber/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/QuickSubscriber/ |
|
The view/QuickSubscriber schema and all instances as JSON. |
(The list will return 0 to 3 view/QuickSubscriber 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/QuickSubscriber/?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.0.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/QuickSubscriber/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/view/QuickSubscriber/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/view/QuickSubscriber/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/view/QuickSubscriber/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "view/QuickSubscriber",
"model_specific_actions": [
"add"
],
"summary_attrs": [
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for view/QuickSubscriber. | GET | /api/view/QuickSubscriber/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/QuickSubscriber as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/QuickSubscriber/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/QuickSubscriber. |