[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": {
"username": {
"title": "Username",
"type": "string",
"required": true
},
"lookUpForUser": {
"title": "Include users at higher hierarchy",
"description": "Includes users above site level when searching",
"type": "boolean"
},
"failIfNotFound": {
"title": "Fail Transaction if user not found",
"description": "used with API to prevent creation of local users where LDAP is in use",
"type": "boolean"
},
"apply_reserved_number_for_user": {
"title": "Auto-Select Pre-Reserved Number For User",
"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>').",
"type": "boolean"
},
"entitlement_profile": {
"title": "Entitlement Profile",
"type": "string",
"required": false
},
"firstname": {
"title": "First Name",
"type": "string",
"required": false
},
"lastname": {
"title": "Last Name",
"type": "string",
"required": true
},
"email": {
"title": "Email Address",
"type": "string",
"format": "email",
"required": false,
"pattern": "^([^.@]+)(\\.[^.@]+)*@([^.@]+\\.)+([^.@]+)$"
},
"send_email": {
"title": "Send welcome email",
"description": "Send Email to user using predefined HTML Email Template. Email template used is 'Quick Add Subscriber'",
"type": "boolean"
},
"send_email_flag": {
"title": "Send Email to user flag",
"description": "Send Email to user using predefined HTML Email Template. Email template used is 'Quick Add Subscriber'",
"type": "boolean"
},
"password": {
"title": "Password",
"description": "The corresponding CUCM, CUC and WebEx user password will be set with this password",
"type": "string",
"is_password": true,
"required": false
},
"pin": {
"title": "PIN",
"description": "The corresponding CUCM and CUC user PIN will be set with this PIN",
"type": "string",
"minLength": 1,
"maxLength": 24,
"is_password": true,
"required": false,
"pattern": "^[0-9]*$"
},
"manager": {
"title": "Manager",
"type": "string",
"required": false
},
"department": {
"title": "Department",
"type": "string",
"required": false
},
"telephoneNumber": {
"title": "Telephone Number",
"type": "string",
"required": false
},
"title": {
"title": "Title",
"type": "string",
"required": false
},
"homeNumber": {
"title": "Home Number",
"type": "string",
"required": false
},
"mobileNumber": {
"title": "User's Mobile Number",
"type": "string",
"required": false
},
"directoryUri": {
"title": "Directory URI",
"type": "string",
"required": false
},
"qagroup_name": {
"title": "Quick Add Group",
"type": "string",
"format": "uri",
"required": true,
"target": "/api/data/QuickAddGroups/choices/?field=group_name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "group_name",
"target_model_type": "data/QuickAddGroups",
"choices": []
},
"device_pool": {
"title": "Device Pools",
"type": "string",
"required": false
},
"class_of_service": {
"title": "Class of Service",
"description": "Select to apply CSS's to lines and devices as defined in the selected Class of Service definition.",
"type": "string",
"required": false
},
"existing": {
"title": "Existing Services",
"type": "object",
"properties": {
"primary_extension": {
"title": "Primary Extension",
"type": "string"
},
"phones": {
"title": "Phones",
"type": "string"
},
"ext_mobilities": {
"title": "Extension Mobility Profiles",
"type": "string"
},
"voicemail": {
"title": "Voicemail Extension",
"type": "string"
},
"webex": {
"title": "Conferencing",
"type": "string"
},
"snr": {
"title": "Single Number Reach",
"type": "string"
},
"spark": {
"title": "Webex App",
"type": "string"
},
"contact_center": {
"title": "Contact Center",
"type": "string"
}
}
},
"user_status": {
"title": "User status",
"type": "string"
},
"automatic_line": {
"title": "Use next available line",
"description": "Use the next available line from the inventory.",
"type": "boolean"
},
"lines": {
"title": "Lines",
"type": "array",
"required": false,
"items": {
"type": "object",
"properties": {
"line_filter": {
"title": "Inventory Filter",
"type": "string",
"required": false,
"default": "default",
"choices": [
{
"value": "default",
"title": "Default"
},
{
"value": "lines_unused_only_local",
"title": "Show Unused Numbers (Site Only)"
},
{
"value": "lines_unused_only",
"title": "Show Unused Numbers"
},
{
"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"
}
]
},
"directory_number": {
"title": "Directory Number",
"type": "string"
}
}
}
},
"voice": {
"title": "Voice",
"type": "boolean"
},
"phones": {
"title": "Phones",
"type": "array",
"items": {
"type": "object",
"properties": {
"phone_name": {
"title": "Phone Name",
"description": "Name of phone to provision for e.g. SEPABCDEFABCDEF",
"type": "string",
"format": "uri",
"target": "/api/device/cucm/Phone/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/Phone",
"choices": []
}
}
}
},
"mobility": {
"title": "Extension Mobility",
"type": "boolean"
},
"voicemail": {
"title": "Voicemail",
"type": "boolean"
},
"webex": {
"title": "WebEx",
"type": "boolean"
},
"pexip": {
"title": "Pexip",
"type": "boolean"
},
"snr": {
"title": "Single Number Reach",
"type": "boolean"
},
"spark": {
"title": "Webex App",
"type": "boolean"
},
"spark_template": {
"title": "Webex App Template",
"type": "string"
},
"contact_center": {
"title": "Contact Center Agent",
"type": "boolean"
},
"contact_center_profile": {
"title": "Agent Profile",
"type": "string"
},
"contact_center_extension": {
"title": "Agent Extension",
"type": "string"
},
"contact_center_device_type": {
"title": "Agent Device Type",
"type": "string",
"default": "Phone",
"choices": [
{
"value": "Phone",
"title": "Phone"
},
{
"value": "Extension Mobility",
"title": "Extension Mobility"
}
]
},
"contact_center_device": {
"title": "Agent Device",
"type": "string"
},
"emcc": {
"title": "EMCC",
"type": "boolean"
},
"mobile_number": {
"title": "SNR Mobile Number",
"type": "string",
"required": false,
"items": {
"attr_props": [],
"choices": []
},
"pattern": "^(\\+?[0-9]*)$",
"choices": [],
"attr_props": []
},
"jabber": {
"title": "Jabber / Dual-Mode Device",
"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.",
"type": "boolean"
},
"jabber_agent": {
"title": "Jabber Agent",
"type": "string",
"choices": [
{
"value": "android",
"title": "Android"
},
{
"value": "csf",
"title": "CSF"
},
{
"value": "ipad",
"title": "iPad"
},
{
"value": "iphone",
"title": "iPhone"
}
]
},
"jabber_devices": {
"title": "Jabber and Dual-Mode Devices",
"type": "array",
"items": {
"type": "object",
"properties": {
"jabber_agent": {
"title": "Jabber / Dual-Mode Agent",
"type": "string",
"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"
}
]
},
"device_name": {
"title": "Device Name",
"type": "string"
},
"mobile_identity": {
"title": "Mobile Identity",
"type": "boolean"
},
"mobile_identity_destination": {
"title": "Destination",
"type": "string"
}
}
}
},
"self_service_id": {
"title": "Enable Self Provisioning",
"type": "boolean"
},
"self_provisioning_profile": {
"title": "Self Provisioning User Profile",
"type": "string",
"required": false
},
"ldap_user": {
"title": "LDAP User",
"type": "string"
},
"data_user": {
"title": "Data User",
"type": "string"
},
"cucm_user": {
"title": "CUCM User",
"type": "string"
},
"cucm_user_ldapDirectoryName": {
"title": "CUCM User LDAP Directory Name",
"type": "string"
},
"phone_template": {
"title": "Phone Template",
"type": "string"
},
"phone_type": {
"title": "Phone Type",
"type": "string"
},
"phone_protocol": {
"title": "Phone Protocol",
"type": "string"
},
"button_template": {
"title": "Phone Button Template",
"type": "string"
},
"security_profile": {
"title": "Phone Security Profile",
"type": "string"
},
"does_phonetype_support_pac": {
"title": "does_phonetype_support_pac",
"type": "boolean"
},
"enable_activation_code": {
"title": "Use Activation Code Onboarding",
"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.",
"type": "boolean"
},
"allowMraMode": {
"title": "Allow MRA Mode",
"type": "boolean"
},
"mraServiceDomain": {
"title": "MRA Service Domain",
"type": "string"
},
"phonetype_entitled": {
"title": "Is PhoneType Entitled?",
"type": "string"
},
"external_trigger": {
"title": "External Auto Trigger?",
"type": "string"
},
"custom_string_1": {
"title": "custom_string_1",
"type": "string"
},
"custom_string_2": {
"title": "custom_string_2",
"type": "string"
},
"custom_string_3": {
"title": "custom_string_3",
"type": "string"
},
"custom_string_4": {
"title": "custom_string_4",
"type": "string"
},
"custom_string_5": {
"title": "custom_string_5",
"type": "string"
},
"custom_string_6": {
"title": "custom_string_6",
"type": "string"
},
"custom_string_7": {
"title": "custom_string_7",
"type": "string"
},
"custom_string_8": {
"title": "custom_string_8",
"type": "string"
},
"custom_string_9": {
"title": "custom_string_9",
"type": "string"
},
"custom_string_10": {
"title": "custom_string_10",
"type": "string"
},
"custom_boolean_1": {
"title": "custom_boolean_1",
"type": "boolean"
},
"custom_boolean_2": {
"title": "custom_boolean_2",
"type": "boolean"
},
"custom_boolean_3": {
"title": "custom_boolean_3",
"type": "boolean"
},
"custom_boolean_4": {
"title": "custom_boolean_4",
"type": "boolean"
},
"custom_boolean_5": {
"title": "custom_boolean_5",
"type": "boolean"
},
"custom_boolean_6": {
"title": "custom_boolean_6",
"type": "boolean"
},
"custom_boolean_7": {
"title": "custom_boolean_7",
"type": "boolean"
},
"custom_boolean_8": {
"title": "custom_boolean_8",
"type": "boolean"
},
"custom_boolean_9": {
"title": "custom_boolean_9",
"type": "boolean"
},
"custom_boolean_10": {
"title": "custom_boolean_10",
"type": "boolean"
}
},
"schema_version": "4.0.5"
}
| 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)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": null,
"direction": "asc",
"current": "/api/view/QuickSubscriber/?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/QuickSubscriber",
"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.0.5",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/view/QuickSubscriber/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/view/QuickSubscriber/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/view/QuickSubscriber/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/view/QuickSubscriber/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"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. |