[Index]
CustomerBuild-AddCiscoWebexApp-WFC_REL
Model ref.: relation/CustomerBuild-AddCiscoWebexApp-WFC_REL
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": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"relation_SparkCustomer": {
"title": "Relation Spark Customer",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"required": true,
"type": "string",
"description": "Name of this customer",
"title": "Customer Name"
},
"account_number_external": {
"type": "string",
"description": "This can be found when logging into the Webex Control Hub portal under the Account menu. E.g. 000fd0e4-83ef-d398-be23-d06998580fed",
"title": "Organization Account Number"
},
"account_email": {
"type": "string",
"description": "This is the email address of the account used to generate the access token.",
"title": "Admin Account Email"
},
"account_number": {
"type": "string",
"description": "This is the internal API id for the organization. This is automatically resolved from the external account number.",
"title": "Organization Account Number (Internal)"
},
"default_calling_behaviour": {
"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"
}
],
"type": "string",
"description": "This is the default calling behaviour for the organization.",
"title": "Default Calling Behaviour"
},
"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 App Control Hub for hybrid calling.",
"title": "Email Domain for Hybrid Calling in Workspaces"
},
"dirsync_enabled": {
"type": "boolean",
"description": "This setting must be enabled if the Organization has been enabled for Directory Synchronization on the Webex Control Hub side.",
"title": "Directory Synchronization Enabled"
},
"notes": {
"type": "string",
"description": "Field to display notes to the user.",
"title": "Please Note"
},
"token_link": {
"format": "link",
"type": "string",
"description": "This is the link to initiate the Webex OAuth flow to obtain tokens.",
"title": "Authorize Webex"
},
"token": {
"is_password": true,
"type": "string",
"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.",
"title": "Admin Access Token"
},
"refresh_token": {
"is_password": true,
"type": "string",
"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.",
"title": "Refresh Token"
},
"access_token_expires": {
"readonly": false,
"type": "string",
"description": "Time when the Access Token will expire.",
"title": "Access Token Expires At"
},
"refresh_token_expires": {
"readonly": false,
"type": "string",
"description": "Time when the Refresh Token will expire.",
"title": "Refresh Token Expires At"
},
"http_proxy": {
"type": "string",
"description": "HTTP Proxy string e.g. http://10.10.10.10:8123",
"title": "HTTP Proxy String"
},
"https_proxy": {
"is_password": true,
"description": "HTTPS Proxy string e.g. https://10.10.10.10:8123",
"title": "HTTPS Proxy String",
"store_encrypted": true,
"type": "string"
},
"sync": {
"default": false,
"type": "boolean",
"description": "Sync this organization's roles and licenses from Control Hub on creation.",
"title": "Sync on Create"
},
"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
}
}
},
"maxItems": 1
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/CustomerBuild-AddCiscoWebexApp-WFC_REL/add/ |
|
The GUI Add form of relation/CustomerBuild-AddCiscoWebexApp-WFC_REL 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/CustomerBuild-AddCiscoWebexApp-WFC_REL | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/CustomerBuild-AddCiscoWebexApp-WFC_REL | POST | /api/relation/CustomerBuild-AddCiscoWebexApp-WFC_REL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/CustomerBuild-AddCiscoWebexApp-WFC_REL/ |
|
The relation/CustomerBuild-AddCiscoWebexApp-WFC_REL schema and all instances as JSON. |
(The list will return 0 to 3 relation/CustomerBuild-AddCiscoWebexApp-WFC_REL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/CustomerBuild-AddCiscoWebexApp-WFC_REL/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree"
},
"operations": [
"update",
"field_display_policy",
"remove",
"help",
"add",
"export",
"list",
"configuration_template",
"get",
"bulk_update",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/CustomerBuild-AddCiscoWebexApp-WFC_REL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"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/CustomerBuild-AddCiscoWebexApp-WFC_REL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"get",
"update",
"remove",
"add",
"export_bulkload_template",
"export",
"list"
],
"schema_version": null,
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/CustomerBuild-AddCiscoWebexApp-WFC_REL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/CustomerBuild-AddCiscoWebexApp-WFC_REL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/CustomerBuild-AddCiscoWebexApp-WFC_REL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/CustomerBuild-AddCiscoWebexApp-WFC_REL/[pkid] | hierarchy=[hierarchy] | The relation/CustomerBuild-AddCiscoWebexApp-WFC_REL instance with [pkid]. |