[Index]
Model ref.: view/LyncQuickSubscriber
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
},
"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": "^([^.@]+)(\\.[^.@]+)*@([^.@]+\\.)+([^.@]+)$"
},
"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",
"is_password": true,
"required": false
},
"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/LyncQuickAddGroups-Teams/choices/?field=group_name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "group_name",
"default": "default",
"target_model_type": "data/LyncQuickAddGroups-Teams",
"choices": []
},
"existing": {
"title": "Existing Services",
"type": "object",
"properties": {
"phones": {
"title": "Phones",
"type": "string"
},
"ext_mobilities": {
"title": "Extension Mobility Profiles",
"type": "string"
},
"voicemail": {
"title": "Voicemail Extension",
"type": "string"
},
"webex": {
"title": "WebEx",
"type": "string"
},
"lync_id": {
"title": "SfB Id",
"type": "string"
},
"ExchangeUM_id": {
"title": "Exchange UM ID",
"type": "integer"
},
"sip_address": {
"title": "SIP Address",
"type": "string"
},
"snr": {
"title": "Single Number Reach",
"type": "string"
}
}
},
"user_status": {
"title": "User status",
"type": "string"
},
"lines": {
"title": "Lines",
"type": "array",
"required": false,
"items": {
"type": "object",
"properties": {
"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"
},
"online_voicemail": {
"title": "Online Mailbox/Voicemail",
"type": "boolean"
},
"webex": {
"title": "WebEx",
"type": "boolean"
},
"lync": {
"title": "SfB Enabled",
"type": "boolean"
},
"online_sfb": {
"title": "Online Skype for Business",
"type": "boolean"
},
"lync_details": {
"type": "object",
"properties": {
"sip_address": {
"title": "SIP Address",
"type": "string"
},
"phone_number": {
"title": "Phone Number",
"type": "string"
},
"ext": {
"title": "Extension",
"type": "string"
},
"id": {
"title": "Id",
"type": "string"
}
}
},
"office365": {
"title": "Office365 Enabled",
"type": "boolean"
},
"ms_teams": {
"title": "Microsoft Teams",
"type": "boolean"
},
"snr": {
"title": "Single Number Reach",
"type": "boolean"
},
"mobile_number": {
"title": "SNR Mobile Number",
"type": "string",
"required": false
},
"jabber": {
"title": "Jabber 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 Devices",
"type": "array",
"items": {
"type": "object",
"properties": {
"jabber_agent": {
"title": "Jabber Agent",
"type": "string",
"choices": [
{
"value": "android",
"title": "Android"
},
{
"value": "csf",
"title": "CSF"
},
{
"value": "ipad",
"title": "iPad"
},
{
"value": "iphone",
"title": "iPhone"
}
]
},
"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"
},
"normalized_user": {
"title": "Normalized 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"
},
"usage_location": {
"title": "Usage Location",
"description": "Location used for Microsoft Licensing",
"type": "string",
"required": false,
"readonly": true
}
},
"schema_version": "1.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/LyncQuickSubscriber/add/ |
|
The GUI Add form of view/LyncQuickSubscriber 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/LyncQuickSubscriber | 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/LyncQuickSubscriber | POST | /api/view/LyncQuickSubscriber/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/LyncQuickSubscriber/ |
|
The view/LyncQuickSubscriber schema and all instances as JSON. |
(The list will return 0 to 3 view/LyncQuickSubscriber instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": null,
"direction": "asc",
"current": "/api/view/LyncQuickSubscriber/?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/LyncQuickSubscriber",
"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": "1.5",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/view/LyncQuickSubscriber/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/view/LyncQuickSubscriber/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/view/LyncQuickSubscriber/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/view/LyncQuickSubscriber/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for view/LyncQuickSubscriber. | GET | /api/view/LyncQuickSubscriber/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/LyncQuickSubscriber as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/LyncQuickSubscriber/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/LyncQuickSubscriber. |