[Index]
Utility model to allow Business Admin Portal to perform macro lookups.
Model ref.: data/BusinessAdminSubscriberLookups
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": {
"line_templates": {
"type": "string",
"description": "Returns the first Line Config Mapping up the hierarchy.",
"title": "Line Config Templates"
},
"cuc_pkid": {
"type": "string",
"description": "Returns the CUC server pkid",
"title": "CUC Server PKID"
},
"lines": {
"type": "string",
"description": "Returns all lines from fn.get_lines macro functions",
"title": "Lines"
},
"associated_profiles": {
"type": "string",
"description": "Returns all user associated device profiles.",
"title": "Associated Device Profiles"
},
"entitlement_profile_allowed_devices": {
"type": "string",
"description": "Returns the given Entitlement Profile's allowed devices",
"title": "Entitlement Profile"
},
"associated_rdp": {
"type": "string",
"description": "Returns all user associated RDP's.",
"title": "Associated RDP's"
},
"phone_types": {
"type": "string",
"description": "Returns Phone Type information",
"title": "Phone Types"
},
"uccx_agent_pkid": {
"type": "string",
"description": "Returns the pkid of the specified CCX Agent",
"title": "UCCX AGent PKID"
},
"em_profiles": {
"type": "string",
"description": "Returns the first Phone Config Mapping up the hierarchy",
"title": "Extension Mobility Config Profiles"
},
"line_pkid_by_pattern": {
"type": "string",
"description": "Returns the line PKID using the pattern only.",
"title": "Line PKID By Pattern"
},
"entitlement_profile": {
"type": "string",
"description": "Returns the Subscriber's Entitlement Profile",
"title": "Entitlement Profile"
},
"webex_teams_pkid": {
"type": "string",
"description": "Returns the Webex Teams connection pkid",
"title": "Webex App PKID"
},
"associated_phones": {
"type": "string",
"description": "Returns all user associated phones.",
"title": "Associated Phones"
},
"voicemail_lines_available": {
"type": "string",
"description": "Returns all lines available for a new Voicemail Account",
"title": "Voicemail Lines Available"
},
"cuc_user_data": {
"type": "string",
"description": "Returns all user associated Voicemail data.",
"title": "Associated Voicemail"
},
"phone_pkid": {
"type": "string",
"description": "Returns the pkid of the specified Phone",
"title": "Phone PKID"
},
"subscriber_profiles": {
"type": "string",
"description": "Returns Subscriber Profiles",
"title": "Subscriber Profiles"
},
"associated_lines": {
"type": "string",
"description": "Returns all user associated lines.",
"title": "Associated Lines"
},
"voicemail_user_pkid": {
"type": "string",
"description": "Returns the pkid of the specified Voicemail User",
"title": "Voicemail User PKID"
},
"ivr_theme": {
"type": "string",
"description": "Returns all IVR themes for Pexip Conference",
"title": "IVR Themes"
},
"associated_webexteam": {
"type": "string",
"description": "Returns all user associated Webex Team data.",
"title": "Associated Webex Team"
},
"headset_pkid": {
"type": "string",
"description": "Returns the pkid of the specified Headset",
"title": "Headset PKID"
},
"name": {
"type": "string",
"title": "Name"
},
"phone_profiles": {
"type": "string",
"description": "Returns the first Phone Config Mapping up the hierarchy.",
"title": "Phone Config Profiles"
},
"pexip_conference_pkid": {
"type": "string",
"description": "Returns the Pexip Server pkid",
"title": "Pexip Server PKID"
},
"line_pkid": {
"type": "string",
"description": "Returns the line PKID.",
"title": "Line PKID"
},
"pexip_conference_account_pkid": {
"type": "string",
"description": "Returns the pkid of the specified Pexip Conference Account",
"title": "Pexip Conference Account PKID"
},
"webex_teams_user_pkid": {
"type": "string",
"description": "Returns the pkid of the specified Webex Teams User",
"title": "Webex App PKID"
},
"uccx_pkid": {
"type": "string",
"description": "Returns the UCCX server pkid",
"title": "UCCX Server PKID"
}
},
"schema_version": "1.0.4"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/BusinessAdminSubscriberLookups/add/ |
|
The GUI Add form of data/BusinessAdminSubscriberLookups 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/data/BusinessAdminSubscriberLookups | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/BusinessAdminSubscriberLookups/ |
|
The data/BusinessAdminSubscriberLookups schema and all instances as JSON. |
(The list will return 0 to 3 data/BusinessAdminSubscriberLookups instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"move",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/BusinessAdminSubscriberLookups/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "?",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "1.0.4",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/data/BusinessAdminSubscriberLookups/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/BusinessAdminSubscriberLookups/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
}
],
"model_type": "data/BusinessAdminSubscriberLookups",
"model_specific_actions": [
"add",
"get",
"list"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/BusinessAdminSubscriberLookups/[pkid] | hierarchy=[hierarchy] | The data/BusinessAdminSubscriberLookups instance with [pkid]. |