[Index]
This relation implements the workflows to manage Spark Customer connection parameters and enabled services.
Model ref.: relation/SparkCustomer
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": {
"name": {
"title": "Customer Name",
"description": "Name of this customer",
"type": "string",
"required": true
},
"account_number_external": {
"title": "Organization Account Number",
"description": "This can be found when logging into the Webex Control Hub portal under the Account menu. E.g. 000fd0e4-83ef-d398-be23-d06998580fed",
"type": "string"
},
"account_email": {
"title": "Admin Account Email",
"description": "This is the email address of the account used to generate the access token.",
"type": "string"
},
"account_number": {
"title": "Organization Account Number (Internal)",
"description": "This is the internal API id for the organization. This is automatically resolved from the external account number.",
"type": "string"
},
"default_calling_behaviour": {
"title": "Default Calling Behaviour",
"description": "This is the default calling behaviour for the organization.",
"type": "string",
"choices": [
{
"value": "Calling in Webex App",
"title": "Calling in Webex App"
},
{
"value": "Calling in Webex App (Unified CM)",
"title": "Calling in Webex App (Unified CM)"
},
{
"value": "Cisco Jabber app",
"title": "Cisco Jabber app"
},
{
"value": "Third-Party app",
"title": "Third-Party app"
}
]
},
"email_domain": {
"title": "Email Domain for Hybrid Calling in Workspaces",
"description": "This is the email domain that will be used when creating a Unified CM user associated with a Workspace in Webex App Control Hub for hybrid calling.",
"type": "string"
},
"dirsync_enabled": {
"title": "Directory Synchronization Enabled",
"description": "This setting must be enabled if the Organization has been enabled for Directory Synchronization on the Webex Control Hub side.",
"type": "boolean"
},
"notes": {
"title": "Please Note",
"description": "Field to display notes to the user.",
"type": "string"
},
"token_link": {
"title": "Authorize Webex",
"description": "This is the link to initiate the Webex OAuth flow to obtain tokens.",
"type": "string",
"format": "link"
},
"token": {
"title": "Admin Access Token",
"description": "This is the Access Token provided when logging into Webex App Developer portal. This token is valid for 14 days. The Refresh token can be used to generate a new Access Token.",
"type": "string",
"is_password": true
},
"refresh_token": {
"title": "Refresh Token",
"description": "This is the Refresh Token provided when logging into Webex App Developer portal. This token will be used to create a new access token. The refresh token is valid for 90 dyas.",
"type": "string",
"is_password": true
},
"access_token_expires": {
"title": "Access Token Expires At",
"description": "Time when the Access Token will expire.",
"type": "string",
"readonly": false
},
"refresh_token_expires": {
"title": "Refresh Token Expires At",
"description": "Time when the Refresh Token will expire.",
"type": "string",
"readonly": false
},
"http_proxy": {
"title": "HTTP Proxy",
"description": "Specifies an outbound internet proxy server for HTTP traffic to the public Internet. The format should be (http(s)://[user:password]@host:port). Note that this is the location of the proxy and the URL scheme is not necessarily \"http\" just because the traffic being forwarded to it is HTTP traffic. Please consult the administrator of the proxy server for the correct URL. Special characters in either the user or password must be URL encoded.",
"type": "string",
"is_password": true,
"store_encrypted": true
},
"https_proxy": {
"title": "HTTPS Proxy",
"description": "Specifies an outbound internet proxy server for HTTPS traffic to the public Internet. The format should be (http(s)://[user:password]@host:port). Note that this is the location of the proxy and the URL scheme is not necessarily \"https\" just because the traffic being forwarded to it is HTTPS traffic. Please consult the administrator of the proxy server for the correct URL. Special characters in either the user or password must be URL encoded.",
"type": "string",
"is_password": true,
"store_encrypted": true
},
"sync": {
"title": "Sync on Create",
"description": "Sync this organization's roles and licenses from Control Hub on creation.",
"type": "boolean",
"default": false
},
"shadow": {
"title": "Shadow",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"maxItems": 1
}
},
"schema_version": "1.2.7"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/SparkCustomer/add/ |
|
The GUI Add form of relation/SparkCustomer 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/SparkCustomer | 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/SparkCustomer/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/SparkCustomer/[pkid1]", "/api/relation/SparkCustomer/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/SparkCustomer/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/SparkCustomer |
|
{"hrefs": ["/api/relation/SparkCustomer/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/SparkCustomer |
|
{"hrefs": ["/api/relation/SparkCustomer/[pkid1]", "/api/relation/SparkCustomer/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/SparkCustomer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/SparkCustomer/export/ |
|
{ "hrefs":["/api/relation/SparkCustomer/[pkid1]", "/api/relation/SparkCustomer/[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/SparkCustomer and the JSON format can be used to import instances of relation/SparkCustomer.
GET http://[host-proxy]/api/relation/SparkCustomer/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/SparkCustomer | POST | /api/relation/SparkCustomer/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/SparkCustomer/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/SparkCustomer/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/SparkCustomer/ |
|
The relation/SparkCustomer schema and all instances as JSON. |
(The list will return 0 to 3 relation/SparkCustomer instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/SparkCustomer/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"export",
"help",
"update",
"bulk_update",
"get",
"move",
"remove",
"list",
"configuration_template",
"add",
"export_bulkload_template",
"field_display_policy"
],
"meta": {
"model_type": "relation/SparkCustomer",
"summary_attrs": [
{
"name": "name",
"title": "Customer Name"
},
{
"name": "account_number_external",
"title": "Organization Account Number"
},
{
"name": "account_email",
"title": "Admin Account Email"
},
{
"name": "default_calling_behaviour",
"title": "Default Calling Behaviour"
},
{
"name": "email_domain",
"title": "Email Domain for Hybrid Calling in Workspaces"
},
{
"name": "dirsync_enabled",
"title": "Directory Synchronization Enabled"
},
{
"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": [],
"self": [
{
"href": "/api/relation/SparkCustomer/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"export",
"help",
"update",
"get",
"move",
"remove",
"list",
"configuration_template",
"export_bulkload_template",
"field_display_policy",
"add"
],
"schema_version": "1.2.7",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/SparkCustomer/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/SparkCustomer/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/SparkCustomer",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/SparkCustomer/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/relation/SparkCustomer/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/relation/SparkCustomer/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/relation/SparkCustomer/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/SparkCustomer/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/SparkCustomer/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/SparkCustomer. | GET | /api/relation/SparkCustomer/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/SparkCustomer as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/SparkCustomer/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/SparkCustomer/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/SparkCustomer | 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/SparkCustomer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/SparkCustomer/[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/SparkCustomer and the JSON format can be used to import instances of relation/SparkCustomer.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/SparkCustomer/[pkid] | hierarchy=[hierarchy] | The relation/SparkCustomer instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/SparkCustomer/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/SparkCustomer. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Refresh Access Token | POST | /api/relation/SparkCustomer/[pkid]/+RefreshAccessToken | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Sync Webex Teams Roles Licences | POST | /api/relation/SparkCustomer/[pkid]/+SyncWebexTeamsRolesLicences | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Sync Webex Teams Users | POST | /api/relation/SparkCustomer/[pkid]/+SyncWebexTeamsUsers | hierarchy=[hierarchy] | If payload required: |