[Index]
This is a data Model to Store Groups of templates used by the Quick Add Subscriber Feature
Model ref.: data/QuickAddGroups
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": {
"group_name": {
"required": true,
"type": "string",
"title": "Group Name"
},
"description": {
"required": false,
"type": "string",
"description": "A description for the Quick Add Group",
"title": "Description"
},
"default_webex_user_template": {
"type": "string",
"title": "WebEx Meetings User Template"
},
"default_cucm_jabber_iphone_template": {
"type": "string",
"title": "Jabber iPhone Template"
},
"default_cucm_jabber_csf_template": {
"type": "string",
"title": "Jabber CSF Template"
},
"default_cucm_jabber_ipad_template": {
"type": "string",
"title": "Jabber iPad Template"
},
"default_cucm_jabber_android_template": {
"type": "string",
"title": "Jabber Android Template"
},
"default_cucm_jabber_cim_template": {
"type": "string",
"title": "Carrier Integrated Mobile Device Template"
},
"default_cucm_jabber_ctird_template": {
"type": "string",
"title": "CTI Remote Device Template"
},
"default_cucm_user_template": {
"required": false,
"type": "string",
"title": "CUCM User Template"
},
"default_cucm_phone_template": {
"type": "string",
"title": "Phone Template"
},
"default_cucm_line_template": {
"type": "string",
"title": "Line Template"
},
"default_cucm_device_profile_template": {
"type": "string",
"title": "Extension Mobility Template"
},
"default_cucm_rdp_template": {
"type": "string",
"title": "Remote Destination Profile Template"
},
"default_cucm_rd_template": {
"type": "string",
"title": "Remote Destination Template"
},
"default_cuc_user_template": {
"type": "string",
"title": "CUC User Template"
},
"default_cuc_user_pin_template": {
"type": "string",
"title": "CUC User PIN Template"
},
"default_cuc_user_password_template": {
"type": "string",
"title": "CUC User Password Template"
},
"default_spark_user_template": {
"type": "string",
"title": "Default Webex Teams User Template"
},
"default_spark_calling_template": {
"type": "string",
"title": "Default Webex Teams Calling Template"
},
"default_spark_user_cti_device_template": {
"type": "string",
"title": "Default Webex Teams User CTI Device Template"
},
"default_spark_user_iphone_device_template": {
"type": "string",
"description": "This template is used for provisioning an iPhone device for a Webex Teams user with CUCM calling behaviour.",
"title": "Default Webex Teams User iPhone Device Template"
},
"default_spark_user_android_device_template": {
"type": "string",
"description": "This template is used for provisioning an Android device for a Webex Teams user with CUCM calling behaviour.",
"title": "Default Webex Teams User Android Device Template"
},
"default_spark_user_tablet_device_template": {
"type": "string",
"description": "This template is used for provisioning a tablet (iPad) device for a Webex Teams user with CUCM calling behaviour.",
"title": "Default Webex Teams User Tablet Device Template"
},
"default_spark_user_csf_device_template": {
"type": "string",
"description": "This template is used for provisioning a CSF device for a Webex Teams user with CUCM calling behaviour.",
"title": "Default Webex Teams User CSF Device Template"
},
"default_ms_365_user_template": {
"type": "string",
"title": "MS 365 User Template"
},
"default_ms_teams_user_template": {
"type": "string",
"title": "MS Teams User Template"
},
"default_ms_groups_add_template": {
"type": "string",
"title": "MS Groups Add Template"
},
"default_ms_groups_remove_template": {
"type": "string",
"title": "MS Groups Remove Template"
},
"default_ms_exchange_online_user_mailbox_template": {
"type": "string",
"title": "MS Exchange Online User Mailbox Template"
},
"default_ms_exchange_online_convert_mailbox_template": {
"type": "string",
"title": "MS Exchange Online Convert Mailbox Template"
},
"default_prs_user_template": {
"type": "string",
"title": "VOSS Phone User Template"
},
"default_pexip_conference_template": {
"type": "string",
"title": "Pexip Conference Template"
},
"custom_template_1": {
"type": "string",
"title": "Custom Template 1"
},
"custom_template_2": {
"type": "string",
"title": "Custom Template 2"
},
"custom_template_3": {
"type": "string",
"title": "Custom Template 3"
},
"custom_template_4": {
"type": "string",
"title": "Custom Template 4"
},
"custom_template_5": {
"type": "string",
"title": "Custom Template 5"
}
},
"schema_version": "3.4"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/QuickAddGroups/add/ |
|
The GUI Add form of data/QuickAddGroups 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/QuickAddGroups | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/QuickAddGroups/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/QuickAddGroups/[pkid1]", "/api/data/QuickAddGroups/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/QuickAddGroups/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/QuickAddGroups/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/QuickAddGroups/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/QuickAddGroups/[pkid1]", "/api/v0/data/QuickAddGroups/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/QuickAddGroups/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/QuickAddGroups; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/QuickAddGroups/export/ |
|
{ "hrefs":["/api/data/QuickAddGroups/[pkid1]", "/api/data/QuickAddGroups/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of data/QuickAddGroups and the JSON format can be used to import instances of data/QuickAddGroups.
GET http://[host-proxy]/api/data/QuickAddGroups/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/QuickAddGroups | POST | /api/data/QuickAddGroups/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/data/QuickAddGroups/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/data/QuickAddGroups/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/QuickAddGroups/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/QuickAddGroups/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/QuickAddGroups/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/QuickAddGroups/ |
|
The data/QuickAddGroups schema and all instances as JSON. |
(The list will return 0 to 3 data/QuickAddGroups instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 32,
"total_limit": null,
"order_by": "group_name",
"direction": "asc",
"current": "/api/data/QuickAddGroups/?skip=0&limit=3&order_by=group_name&direction=asc&traversal=fulltree"
},
"operations": [
"field_display_policy",
"update",
"help",
"remove",
"move",
"add",
"export",
"list",
"configuration_template",
"get",
"bulk_update_form",
"migration",
"transform",
"export_bulkload_template"
],
"meta": {
"model_type": "data/QuickAddGroups",
"summary_attrs": [
{
"name": "group_name",
"title": "Group Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "default_cucm_user_template",
"title": "CUCM User Template"
},
{
"name": "default_cucm_phone_template",
"title": "Phone Template"
},
{
"name": "default_cucm_line_template",
"title": "Line Template"
},
{
"name": "default_cuc_user_template",
"title": "CUC User Template"
},
{
"name": "default_ms_365_user_template",
"title": "MS 365 User Template"
},
{
"name": "default_ms_teams_user_template",
"title": "MS Teams User Template"
},
{
"name": "default_ms_groups_add_template",
"title": "MS Groups Add Template"
},
{
"name": "default_ms_groups_remove_template",
"title": "MS Groups Remove Template"
},
{
"name": "default_spark_user_template",
"title": "Default Webex App User Template"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {
"hierarchy": true,
"unique": [
"group_name"
]
},
"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",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"migration",
"remove",
"tag",
"tag_version",
"update"
],
"schema_version": "3.4",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/QuickAddGroups/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/QuickAddGroups/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/data/QuickAddGroups/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/QuickAddGroups/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/data/QuickAddGroups/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/QuickAddGroups/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/QuickAddGroups/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/data/QuickAddGroups/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/QuickAddGroups/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/data/QuickAddGroups/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/QuickAddGroups/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/QuickAddGroups/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"default_cucm_jabber_csf_template": "CS-P PC Jabber CSF Template",
"group_name": "AB_Group-QAG_BasicUser - 6921 SCCP",
"default_cucm_jabber_android_template": "CS-P Mobile Jabber Android Template",
"pkid": "5ae89ec1affa931cce38ba36",
"default_cucm_device_profile_template": "CS-P Device Profile Template 6921 SCCP",
"default_spark_user_tablet_device_template": "Default Webex Teams Tablet Device Template",
"default_spark_user_android_device_template": "Default Webex Teams Android Device Template",
"default_spark_user_iphone_device_template": "Default Webex Teams iPhone Device Template",
"default_cucm_line_template": "CS-P Line Template (VM-FWD)",
"default_cucm_rdp_template": "CS-P SNR RDP Template",
"default_ms_teams_user_template": "Reference Microsoft Teams Online User Template",
"default_spark_user_csf_device_template": "Default Webex Teams CSF Device Template",
"default_prs_user_template": "",
"default_cuc_user_template": "CS-P CUC User Template LDAP",
"default_cucm_phone_template": "CS-P Phone Template 6921 SCCP",
"default_cucm_rd_template": "CS-P SNR RD Template",
"default_cucm_jabber_iphone_template": "CS-P Mobile Jabber iPhone Template",
"default_cucm_jabber_ipad_template": "CS-P Mobile Jabber iPad Template",
"default_cucm_user_template": "CS-P Standard User Template",
"default_ms_365_user_template": "Reference MS365 User Template",
"default_pexip_conference_template": "Reference Pexip Conference Template",
"default_webex_user_template": "CS-P Webex User Template",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "data/QuickAddGroups",
"summary_attrs": [
{
"name": "group_name",
"title": "Group Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "default_cucm_user_template",
"title": "CUCM User Template"
},
{
"name": "default_cucm_phone_template",
"title": "Phone Template"
},
{
"name": "default_cucm_line_template",
"title": "Line Template"
},
{
"name": "default_cuc_user_template",
"title": "CUC User Template"
},
{
"name": "default_ms_365_user_template",
"title": "MS 365 User Template"
},
{
"name": "default_ms_teams_user_template",
"title": "MS Teams User Template"
},
{
"name": "default_ms_groups_add_template",
"title": "MS Groups Add Template"
},
{
"name": "default_ms_groups_remove_template",
"title": "MS Groups Remove Template"
},
{
"name": "default_spark_user_template",
"title": "Default Webex App User Template"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "AB_Group-QAG_BasicUser - 6921 SCCP",
"business_key": {
"hierarchy": true,
"unique": [
"group_name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/",
"pkid": "5ae89ec1affa931cce38ba35"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89ec1affa931cce38ba35"
],
"schema_version": "3.4",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ae89ec1affa931cce38ba35"
},
{
"data": {
"default_cucm_jabber_csf_template": "CS-P PC Jabber CSF Template",
"group_name": "AB_Group-QAG_BasicUser - 6921 SCCP - CallWaiting",
"default_cucm_jabber_android_template": "CS-P Mobile Jabber Android Template",
"pkid": "5ae89ec1affa931cce38ba3f",
"default_cucm_device_profile_template": "CS-P Device Profile Template 6921 SCCP",
"default_spark_user_tablet_device_template": "Default Webex Teams Tablet Device Template",
"default_spark_user_android_device_template": "Default Webex Teams Android Device Template",
"default_spark_user_iphone_device_template": "Default Webex Teams iPhone Device Template",
"default_cucm_line_template": "CS-P Line Template 6921-CallWaiting-FWD",
"default_cucm_rdp_template": "CS-P SNR RDP Template",
"default_ms_teams_user_template": "Reference Microsoft Teams Online User Template",
"default_spark_user_csf_device_template": "Default Webex Teams CSF Device Template",
"default_prs_user_template": "",
"default_cuc_user_template": "CS-P CUC User Template LDAP",
"default_cucm_phone_template": "CS-P Phone Template 6921 SCCP",
"default_cucm_rd_template": "CS-P SNR RD Template",
"default_cucm_jabber_iphone_template": "CS-P Mobile Jabber iPhone Template",
"default_cucm_jabber_ipad_template": "CS-P Mobile Jabber iPad Template",
"default_cucm_user_template": "CS-P Standard User Template",
"default_ms_365_user_template": "Reference MS365 User Template",
"default_pexip_conference_template": "Reference Pexip Conference Template",
"default_webex_user_template": "CS-P Webex User Template",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "data/QuickAddGroups",
"summary_attrs": [
{
"name": "group_name",
"title": "Group Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "default_cucm_user_template",
"title": "CUCM User Template"
},
{
"name": "default_cucm_phone_template",
"title": "Phone Template"
},
{
"name": "default_cucm_line_template",
"title": "Line Template"
},
{
"name": "default_cuc_user_template",
"title": "CUC User Template"
},
{
"name": "default_ms_365_user_template",
"title": "MS 365 User Template"
},
{
"name": "default_ms_teams_user_template",
"title": "MS Teams User Template"
},
{
"name": "default_ms_groups_add_template",
"title": "MS Groups Add Template"
},
{
"name": "default_ms_groups_remove_template",
"title": "MS Groups Remove Template"
},
{
"name": "default_spark_user_template",
"title": "Default Webex App User Template"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "AB_Group-QAG_BasicUser - 6921 SCCP - CallWaiting",
"business_key": {
"hierarchy": true,
"unique": [
"group_name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba3e/",
"pkid": "5ae89ec1affa931cce38ba3e"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89ec1affa931cce38ba3e"
],
"schema_version": "3.4",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba3e/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba3e/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba3e/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba3e/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba3e/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba3e/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba3e/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba3e/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ae89ec1affa931cce38ba3e"
},
{
"data": {
"default_cucm_jabber_csf_template": "CS-P PC Jabber CSF Template",
"group_name": "AB_Group-QAG_ExecUser - 9951 SIP",
"default_cucm_jabber_android_template": "CS-P Mobile Jabber Android Template",
"pkid": "5ae89ec3affa931cce38ba7e",
"default_cucm_device_profile_template": "CS-P Device Profile Template 9951 SIP",
"default_spark_user_tablet_device_template": "Default Webex Teams Tablet Device Template",
"default_spark_user_android_device_template": "Default Webex Teams Android Device Template",
"default_spark_user_iphone_device_template": "Default Webex Teams iPhone Device Template",
"default_cucm_line_template": "CS-P Line Template (VM-FWD)",
"default_cucm_rdp_template": "CS-P SNR RDP Template",
"default_ms_teams_user_template": "Reference Microsoft Teams Online User Template",
"default_spark_user_csf_device_template": "Default Webex Teams CSF Device Template",
"default_prs_user_template": "",
"default_cuc_user_template": "CS-P CUC User Template LDAP",
"default_cucm_phone_template": "CS-P Phone Template 9951 SIP",
"default_cucm_rd_template": "CS-P SNR RD Template",
"default_cucm_jabber_iphone_template": "CS-P Mobile Jabber iPhone Template",
"default_cucm_jabber_ipad_template": "CS-P Mobile Jabber iPad Template",
"default_cucm_user_template": "CS-P Standard User Template",
"default_ms_365_user_template": "Reference MS365 User Template",
"default_pexip_conference_template": "Reference Pexip Conference Template",
"default_webex_user_template": "CS-P Webex User Template",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "data/QuickAddGroups",
"summary_attrs": [
{
"name": "group_name",
"title": "Group Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "default_cucm_user_template",
"title": "CUCM User Template"
},
{
"name": "default_cucm_phone_template",
"title": "Phone Template"
},
{
"name": "default_cucm_line_template",
"title": "Line Template"
},
{
"name": "default_cuc_user_template",
"title": "CUC User Template"
},
{
"name": "default_ms_365_user_template",
"title": "MS 365 User Template"
},
{
"name": "default_ms_teams_user_template",
"title": "MS Teams User Template"
},
{
"name": "default_ms_groups_add_template",
"title": "MS Groups Add Template"
},
{
"name": "default_ms_groups_remove_template",
"title": "MS Groups Remove Template"
},
{
"name": "default_spark_user_template",
"title": "Default Webex App User Template"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "AB_Group-QAG_ExecUser - 9951 SIP",
"business_key": {
"hierarchy": true,
"unique": [
"group_name"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/QuickAddGroups/5ae89ec3affa931cce38ba7d/",
"pkid": "5ae89ec3affa931cce38ba7d"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89ec3affa931cce38ba7d"
],
"schema_version": "3.4",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/QuickAddGroups/5ae89ec3affa931cce38ba7d/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/QuickAddGroups/5ae89ec3affa931cce38ba7d/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/QuickAddGroups/5ae89ec3affa931cce38ba7d/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/QuickAddGroups/5ae89ec3affa931cce38ba7d/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/QuickAddGroups/5ae89ec3affa931cce38ba7d/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/QuickAddGroups/5ae89ec3affa931cce38ba7d/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/QuickAddGroups/5ae89ec3affa931cce38ba7d/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/QuickAddGroups/5ae89ec3affa931cce38ba7d/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ae89ec3affa931cce38ba7d"
}
]
}
(Show the first instance)
{
"data": {
"default_cucm_jabber_csf_template": "CS-P PC Jabber CSF Template",
"group_name": "AB_Group-QAG_BasicUser - 6921 SCCP",
"default_cucm_jabber_android_template": "CS-P Mobile Jabber Android Template",
"default_cucm_device_profile_template": "CS-P Device Profile Template 6921 SCCP",
"default_spark_user_tablet_device_template": "Default Webex Teams Tablet Device Template",
"default_spark_user_android_device_template": "Default Webex Teams Android Device Template",
"default_spark_user_iphone_device_template": "Default Webex Teams iPhone Device Template",
"default_cucm_line_template": "CS-P Line Template (VM-FWD)",
"default_cucm_rdp_template": "CS-P SNR RDP Template",
"default_ms_teams_user_template": "Reference Microsoft Teams Online User Template",
"default_spark_user_csf_device_template": "Default Webex Teams CSF Device Template",
"default_prs_user_template": "",
"default_cuc_user_template": "CS-P CUC User Template LDAP",
"default_cucm_phone_template": "CS-P Phone Template 6921 SCCP",
"default_cucm_rd_template": "CS-P SNR RD Template",
"default_cucm_jabber_iphone_template": "CS-P Mobile Jabber iPhone Template",
"default_cucm_jabber_ipad_template": "CS-P Mobile Jabber iPad Template",
"default_cucm_user_template": "CS-P Standard User Template",
"default_ms_365_user_template": "Reference MS365 User Template",
"default_pexip_conference_template": "Reference Pexip Conference Template",
"default_webex_user_template": "CS-P Webex User Template",
"pkid": "5ae89ec1affa931cce38ba36"
},
"meta": {
"model_type": "data/QuickAddGroups",
"summary_attrs": [
{
"name": "group_name",
"title": "Group Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "default_cucm_user_template",
"title": "CUCM User Template"
},
{
"name": "default_cucm_phone_template",
"title": "Phone Template"
},
{
"name": "default_cucm_line_template",
"title": "Line Template"
},
{
"name": "default_cuc_user_template",
"title": "CUC User Template"
},
{
"name": "default_ms_365_user_template",
"title": "MS 365 User Template"
},
{
"name": "default_ms_teams_user_template",
"title": "MS Teams User Template"
},
{
"name": "default_ms_groups_add_template",
"title": "MS Groups Add Template"
},
{
"name": "default_ms_groups_remove_template",
"title": "MS Groups Remove Template"
},
{
"name": "default_spark_user_template",
"title": "Default Webex Teams User Template"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "AB_Group-QAG_BasicUser - 6921 SCCP",
"business_key": {
"hierarchy": true,
"unique": [
"group_name"
]
},
"api_version": "21.2",
"cached": false,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523",
"pkid": "5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/",
"pkid": "5ae89ec1affa931cce38ba35"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89ec1affa931cce38ba35"
],
"schema_version": "3.4",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/QuickAddGroups/5ae89ec1affa931cce38ba35/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "5ae89ec1affa931cce38ba35"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/QuickAddGroups. | GET | /api/data/QuickAddGroups/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/QuickAddGroups as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/QuickAddGroups/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/QuickAddGroups/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/QuickAddGroups/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/QuickAddGroups/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/QuickAddGroups; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/QuickAddGroups/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of data/QuickAddGroups and the JSON format can be used to import instances of data/QuickAddGroups.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/QuickAddGroups/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/QuickAddGroups/[pkid] | hierarchy=[hierarchy] | The data/QuickAddGroups instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/QuickAddGroups/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/QuickAddGroups. |