[Index]
This model stores information about a Webex Teams Customer
Model ref.: data/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": {
"access_token_expires": {
"readonly": true,
"type": "string",
"description": "Time when the Access Token will expire.",
"title": "Access Token Expires In"
},
"calling_behaviour_use_org_domain": {
"type": "boolean",
"description": "This is the global setting that determines whether to use the Webex Teams organization domain for Calling in Webex Teams (Unified CM).",
"title": "Use Organization's Domain"
},
"default_calling_behaviour": {
"title": "Default Calling Behaviour",
"type": "string",
"description": "This is the default calling behaviour for the organization.",
"choices": [
{
"value": "Calling in Webex Teams",
"title": "Calling in Webex Teams"
},
{
"value": "Calling in Webex Teams (Unified CM)",
"title": "Calling in Webex Teams (Unified CM)"
},
{
"value": "Cisco Jabber app",
"title": "Cisco Jabber app"
}
]
},
"name": {
"required": true,
"type": "string",
"description": "Name of this customer",
"title": "Customer Name"
},
"uc_manager_profiles": {
"items": {
"type": "string"
},
"type": "array",
"description": "This list of UC Manager profiles must be configured to match the list of profiles in Webex Teams Control Hub.",
"title": "UC Manager Profiles"
},
"jabber_team_messaging_mode": {
"type": "boolean",
"description": "This setting must be enabled if Jabber Team Messaging Mode is enabled in Webex Teams Control Hub.",
"title": "Jabber Team Messaging Mode Enabled"
},
"http_proxy": {
"type": "string",
"description": "HTTP Proxy string e.g. http://10.10.10.10:8123",
"title": "HTTP Proxy String"
},
"dirsync_enabled": {
"type": "boolean",
"description": "This setting must be enabled if the Organization has been Directory Synchronization has been enabled on the Webex Control Hub side.",
"title": "Directory Synchronization Enabled"
},
"default_calling_behaviour_uc_manager_profile": {
"type": "string",
"description": "This is the default UC Manager Profile for when the calling behaviour is Calling in Webex Teams (Unified CM).",
"title": "Default UC Manager Profile"
},
"sync": {
"default": false,
"type": "boolean",
"description": "Sync this organization's roles and licenses from Control Hub on creation.",
"title": "Sync on Create"
},
"https_proxy": {
"store_encrypted": true,
"is_password": true,
"type": "string",
"description": "HTTPS Proxy string e.g. https://10.10.10.10:8123",
"title": "HTTPS Proxy String"
},
"token": {
"is_password": true,
"type": "string",
"description": "This is the Access Token provided when logging into Webex Teams Developer portal. This token is valid for 14 days. The Refresh token can be used to generate a new Access Token.",
"title": "Admin Access Token"
},
"refresh_token_expires": {
"readonly": true,
"type": "string",
"description": "Time when the Refresh Token will expire.",
"title": "Refresh Token Expires In"
},
"account_number": {
"required": true,
"type": "string",
"description": "This can be found when logging into the Webex Teams Admin portal under the My Company Info section",
"title": "Organization Account Number"
},
"email_domain": {
"type": "string",
"description": "This is the email domain that will be used when creating a Unified CM user associated with a Workspace in Webex Teams Control Hub for hybrid calling.",
"title": "Email Domain for Hybrid Calling in Workspaces"
},
"subscription_id": {
"type": "string",
"description": "This is the Subscription ID to be used for license selection e.g. Sub160730. Only licenses of this Subscription ID will be synced into VOSS Automate and be assignable to users.",
"title": "Subscription ID"
},
"site_url": {
"type": "string",
"description": "This is the Site URL to use for assigning 'Meeting - Webex Enterprise Edition' licenses. If this is not set, the license will not be synced into VOSS Automate and will not be assignable to users",
"title": "Site URL"
},
"refresh_token": {
"is_password": true,
"type": "string",
"description": "This is the Refresh Token provided when logging into Webex Teams Developer portal. This token will be used to create a new access token. The refresh token is valid for 90 dyas.",
"title": "Refresh Token"
},
"enterprise_content_management": {
"type": "boolean",
"description": "This setting must be enabled if Content Management is enabled in Webex Teams Control Hub.",
"title": "Enterprise Content Management Enabled"
}
},
"schema_version": "1.7"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/SparkCustomer/add/ |
|
The GUI Add form of data/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/data/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/data/SparkCustomer/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/SparkCustomer/[pkid1]", "/api/data/SparkCustomer/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/SparkCustomer/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/SparkCustomer/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/SparkCustomer/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/SparkCustomer/[pkid1]", "/api/v0/data/SparkCustomer/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/SparkCustomer/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/SparkCustomer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/SparkCustomer/export/ |
|
{ "hrefs":["/api/data/SparkCustomer/[pkid1]", "/api/data/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 data/SparkCustomer and the JSON format can be used to import instances of data/SparkCustomer.
GET http://[host-proxy]/api/data/SparkCustomer/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/SparkCustomer | POST | /api/data/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/data/SparkCustomer/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/SparkCustomer/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/SparkCustomer/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/SparkCustomer/ |
|
The data/SparkCustomer schema and all instances as JSON. |
(The list will return 0 to 3 data/SparkCustomer 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/SparkCustomer/?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": {},
"schema_version": "1.7",
"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/SparkCustomer/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/SparkCustomer/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/data/SparkCustomer/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/SparkCustomer/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/data/SparkCustomer/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/SparkCustomer/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/SparkCustomer/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/data/SparkCustomer/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/SparkCustomer/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/data/SparkCustomer/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/SparkCustomer/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/SparkCustomer/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/data/SparkCustomer/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "data/SparkCustomer",
"model_specific_actions": [
"add",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"migration",
"transform",
"remove",
"tag",
"tag_version",
"update"
],
"summary_attrs": [
{
"name": "name",
"title": "Customer Name"
},
{
"name": "account_number",
"title": "Organization Account Number"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/SparkCustomer. | GET | /api/data/SparkCustomer/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/SparkCustomer as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/SparkCustomer/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/SparkCustomer/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/SparkCustomer/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/SparkCustomer/?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/SparkCustomer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/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 data/SparkCustomer and the JSON format can be used to import instances of data/SparkCustomer.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/SparkCustomer/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/SparkCustomer/[pkid]/ | hierarchy=[hierarchy] | The data/SparkCustomer instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/SparkCustomer/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/SparkCustomer. |