[Index]

API Reference for relation/SparkCustomer

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.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/relation/SparkCustomer/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$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"
          }, 
          "shadow": {
               "items": {
                    "type": "object", 
                    "properties": {
                         "name": {
                              "is_password": false, 
                              "title": "Name", 
                              "required": true, 
                              "displayable": false, 
                              "readonly": false, 
                              "maxLength": 1024, 
                              "type": "string"
                         }
                    }
               }, 
               "type": "array", 
               "maxItems": 1, 
               "title": "Shadow"
          }, 
          "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.2.5"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/relation/SparkCustomer/add/	hierarchy=[hierarchy] format=json	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]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

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]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: relation/SparkCustomer
```
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	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/relation/SparkCustomer/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=relation/SparkCustomer	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/relation/SparkCustomer/[pkid1]", "/api/relation/SparkCustomer/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/relation/SparkCustomer/?hierarchy=[hierarchy]&format=json&schema_rules=true

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/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "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.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for 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/	hierarchy=[hierarchy] modeltype=relation/SparkCustomer	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 call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

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 call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/relation/SparkCustomer/	hierarchy=[hierarchy] format=json schema=true	The relation/SparkCustomer schema and all instances as JSON.

(The list will return 0 to 3 relation/SparkCustomer instances)

GET http://[host]/api/relation/SparkCustomer/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "field_display_policy", 
          "configuration_template", 
          "help", 
          "get", 
          "export_bulkload_template", 
          "move", 
          "list", 
          "update", 
          "remove", 
          "add", 
          "bulk_update", 
          "export"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "name", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/relation/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.2.5", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "self": [
                    {
                         "pkid": null, 
                         "href": "/api/relation/SparkCustomer/None/"
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "add": {
                         "support_async": false, 
                         "class": "add", 
                         "href": "/api/relation/SparkCustomer/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/relation/SparkCustomer/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "move": {
                         "title": "Move", 
                         "support_async": true, 
                         "class": "move", 
                         "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/SparkCustomer", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/relation/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/relation/SparkCustomer/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/relation/SparkCustomer/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/relation/SparkCustomer/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/relation/SparkCustomer/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/relation/SparkCustomer/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }
          ], 
          "model_type": "relation/SparkCustomer", 
          "model_specific_actions": [
               "field_display_policy", 
               "configuration_template", 
               "help", 
               "get", 
               "export_bulkload_template", 
               "move", 
               "list", 
               "update", 
               "remove", 
               "add", 
               "export"
          ], 
          "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 relation/SparkCustomer.	GET	/api/relation/SparkCustomer/help	hierarchy=[hierarchy]	On-line help of Model ref.: relation/SparkCustomer as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

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/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	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:

API Reference for relation/SparkCustomer

GET http://[host-proxy]/api/relation/SparkCustomer/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/relation/SparkCustomer/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Move

Export

Get

Help

Refresh Access Token

Sync Webex Teams Roles Licences

Sync Webex Teams Users