[Index]
This relation implements the workflows to manage Spark Users.
Model ref.: relation/SparkUser
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": {
"status": {
"type": "string",
"title": "Status"
},
"SparkServices": {
"type": "object",
"properties": {
"hybrid_call_services_connect": {
"type": "string"
},
"meeting_webex_enterprise_200": {
"type": "string"
},
"name": {
"type": "string"
},
"meeting_webex_meeting_center": {
"type": "string"
},
"message_messaging": {
"type": "string"
},
"meeting_meeting": {
"type": "string"
},
"hybrid_call_services_aware": {
"type": "string"
},
"hybrid_message_services_message": {
"type": "string"
},
"meeting_webex_training_center": {
"type": "string"
},
"hybrid_calendar_services_microsoft_exchange": {
"type": "string"
},
"meeting_webex_support_center": {
"type": "string"
},
"meeting_webex_event_center": {
"type": "string"
},
"meeting_webex_cmr": {
"type": "string"
},
"hybrid_calendar_services_google": {
"type": "string"
}
},
"title": "Spark Services"
},
"roles": {
"type": "object",
"properties": {
"user_device": {
"type": "boolean",
"description": " - User Management\n - Device Management\n - Licenses & Upgrades",
"title": "User and Device Administrator"
},
"none": {
"default": "true",
"type": "boolean",
"title": "No administrator privileges"
},
"full": {
"type": "boolean",
"description": " - User Management\n - Company Policy & Templates\n - Analytics & Reports\n - Support Metrics & Notifications\n - Licenses & Upgrades\n - Assign Roles",
"title": "Full administrator privileges"
},
"support": {
"type": "boolean",
"description": " - Analytics & Reports\n - Support Metrics & Notifications",
"title": "Support Administrator"
},
"readonly": {
"type": "boolean",
"description": "Read-only view of the portal. No changes will be accepted.",
"title": "Read-only administrator privileges"
},
"device": {
"type": "boolean",
"description": " - Device Management",
"title": "Device Administrator"
}
},
"title": "Roles"
},
"firstName": {
"type": "string",
"title": "First Name"
},
"lastName": {
"type": "string",
"title": "Last Name"
},
"email": {
"required": true,
"type": "string",
"title": "Email Address"
},
"invitePending": {
"type": "boolean",
"title": "Invite Pending"
},
"services": {
"type": "object",
"properties": {
"hybrid_call_services": {
"type": "object",
"properties": {
"connect": {
"type": "boolean",
"description": "Users' incoming calls will ring their work phones and the Cisco Spark app. Users can call their colleagues from either their phones or the app, too.\nAware must be enabled before the user can be enabled for Connect.",
"title": "Connect"
},
"aware": {
"type": "boolean",
"description": "Users can share content from the Cisco Spark app during a call from their work phones and view their call history in the app.",
"title": "Aware"
}
},
"title": "Hybrid Call Services"
},
"message": {
"type": "object",
"properties": {
"messaging": {
"type": "boolean",
"description": "Named User Licence",
"title": "Webex Teams Messaging"
}
},
"title": "Message"
},
"meeting": {
"type": "object",
"properties": {
"webex_enterprise_200": {
"type": "boolean",
"description": "Named User Licence. Each Named User license allows 1 user to be entitled as a meeting host. Named users can hold unlimited meetings.",
"title": "Webex Enterprise Edition 200"
},
"webex_support_center": {
"type": "boolean",
"title": "Webex Support Center"
},
"webex_meeting_center": {
"type": "boolean",
"title": "Webex Meeting Center"
},
"webex_cmr": {
"type": "boolean",
"title": "Webex Collaboration Meeting Rooms"
},
"webex_event_center": {
"type": "boolean",
"title": "Webex Event Center"
},
"webex_training_center": {
"type": "boolean",
"title": "Webex Training Center"
},
"meeting": {
"type": "boolean",
"description": "Named User Licence. Each Named User license allows 1 user to be entitled as a meeting host. Named users can hold unlimited meetings.",
"title": "Webex Teams 25 Party Meetings"
}
},
"title": "Meeting"
},
"hybrid_calendar_services": {
"properties": {
"google": {
"type": "boolean",
"title": "Google Calendar"
},
"microsoft_exchange": {
"type": "boolean",
"title": "Microsoft Exchange/Office 365"
}
},
"type": "object",
"description": "Add @spark to an invitation to create a Cisco Spark room for your meeting. Add @webex to attach your WebEx Personal Room.",
"title": "Hybrid Calendar Services"
},
"hybrid_message_services": {
"type": "object",
"properties": {
"message": {
"type": "boolean",
"description": "Hybrid Message Services",
"title": "Message"
}
},
"title": "Hybrid Message Services"
}
},
"title": "Services"
},
"line": {
"required": false,
"type": "string",
"title": "Line"
},
"id": {
"type": "string",
"title": "Id"
},
"loginEnabled": {
"type": "boolean",
"title": "Login Enabled"
}
},
"schema_version": "1.2.3"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/SparkUser/add/ |
|
The GUI Add form of relation/SparkUser 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/relation/SparkUser/ | 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/relation/SparkUser/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/SparkUser/[pkid1]", "/api/relation/SparkUser/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/SparkUser/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/SparkUser |
|
{"hrefs": ["/api/relation/SparkUser/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/SparkUser |
|
{"hrefs": ["/api/relation/SparkUser/[pkid1]", "/api/relation/SparkUser/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/SparkUser; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/SparkUser/export/ |
|
{ "hrefs":["/api/relation/SparkUser/[pkid1]", "/api/relation/SparkUser/[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 relation/SparkUser and the JSON format can be used to import instances of relation/SparkUser.
GET http://[host-proxy]/api/relation/SparkUser/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/SparkUser | POST | /api/relation/SparkUser/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/SparkUser/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/SparkUser/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/SparkUser/ |
|
The relation/SparkUser schema and all instances as JSON. |
(The list will return 0 to 3 relation/SparkUser instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"move",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "firstName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/SparkUser/?skip=0&limit=3&order_by=firstName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "1.2.3",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/SparkUser/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/SparkUser/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/SparkUser/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/SparkUser",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/SparkUser/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/SparkUser/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/relation/SparkUser/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/relation/SparkUser/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/SparkUser/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/SparkUser/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/SparkUser",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"move",
"list",
"update",
"remove",
"add",
"export"
],
"summary_attrs": [
{
"name": "firstName",
"title": "First Name"
},
{
"name": "lastName",
"title": "Last Name"
},
{
"name": "email",
"title": "Email Address"
},
{
"name": "invitePending",
"title": "Invite Pending"
},
{
"name": "loginEnabled",
"title": "Login Enabled"
},
{
"allow_filtering": false,
"allow_ordering": false,
"name": "services.message.messaging",
"title": "Webex Teams Messaging"
},
{
"allow_filtering": false,
"allow_ordering": false,
"name": "services.meeting.meeting",
"title": "Webex Teams 25 Party Meetings"
},
{
"allow_filtering": false,
"allow_ordering": false,
"name": "services.meeting.webex_enterprise_200",
"title": "Webex Enterprise Edition 200"
},
{
"allow_filtering": false,
"allow_ordering": false,
"name": "services.meeting.webex_cmr",
"title": "Webex Collaboration Meeting Rooms"
},
{
"allow_filtering": false,
"allow_ordering": false,
"name": "services.meeting.webex_event_center",
"title": "Webex Event Center"
},
{
"allow_filtering": false,
"allow_ordering": false,
"name": "services.meeting.webex_meeting_center",
"title": "Webex Meeting Center"
},
{
"allow_filtering": false,
"allow_ordering": false,
"name": "services.meeting.webex_support_center",
"title": "Webex Support Center"
},
{
"allow_filtering": false,
"allow_ordering": false,
"name": "services.meeting.webex_training_center",
"title": "Webex Training Center"
},
{
"allow_filtering": false,
"allow_ordering": false,
"name": "services.hybrid_calendar_services.microsoft_exchange",
"title": "Microsoft Exchange/Office 365"
},
{
"allow_filtering": false,
"allow_ordering": false,
"name": "services.hybrid_calendar_services.google",
"title": "Google Calendar"
},
{
"allow_filtering": false,
"allow_ordering": false,
"name": "services.hybrid_call_services.aware",
"title": "Aware"
},
{
"allow_filtering": false,
"allow_ordering": false,
"name": "services.hybrid_call_services.connect",
"title": "Connect"
},
{
"allow_filtering": false,
"allow_ordering": false,
"name": "services.hybrid_message_services.message",
"title": "Message"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/SparkUser. | GET | /api/relation/SparkUser/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/SparkUser as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/SparkUser/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/SparkUser/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/SparkUser | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/SparkUser; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/SparkUser/[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 relation/SparkUser and the JSON format can be used to import instances of relation/SparkUser.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/SparkUser/[pkid]/ | hierarchy=[hierarchy] | The relation/SparkUser instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/SparkUser/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/SparkUser. |