[Index]
Model ref.: view/QuickAddWebexDevice
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": {
"product": {
"title": "Product",
"type": "string",
"required": true
},
"model": {
"type": "string",
"required": false
},
"workspaceName": {
"title": "Workspace",
"type": "string",
"required": false
},
"workspaceCapacity": {
"title": "Capacity",
"type": "integer",
"required": false
},
"workspaceType": {
"title": "Type",
"type": "string",
"required": false,
"choices": [
{
"value": "",
"title": "No workspace type set"
},
{
"value": "desk",
"title": "Desk - individual"
},
{
"value": "focus",
"title": "Focus - high concentration"
},
{
"value": "huddle",
"title": "Huddle - brainstorm/collaboration"
},
{
"value": "meetingRoom",
"title": "Meeting Room - dedicated meeting space"
},
{
"value": "open",
"title": "Open Space"
},
{
"value": "other",
"title": "Other"
}
]
},
"supportedDevices": {
"title": "Supported Devices",
"type": "string",
"required": false,
"choices": [
{
"value": "collaborationDevices",
"title": "Collaboration Devices"
},
{
"value": "phones",
"title": "Phones"
}
]
},
"callingType": {
"title": "Calling Type",
"type": "string",
"required": false,
"default": "webexCalling",
"choices": [
{
"value": "none",
"title": "No calling type set"
},
{
"value": "freeCalling",
"title": "Free Calling"
},
{
"value": "webexEdgeForDevices",
"title": "Webex Edge For Devices"
},
{
"value": "thirdPartySipCalling",
"title": "Third Party Sip Calling"
},
{
"value": "webexCalling",
"title": "Webex Calling"
}
]
},
"phoneNumber": {
"title": "Phone Number",
"type": "string",
"required": false
},
"extension": {
"title": "Extension",
"type": "string",
"required": false
},
"workspaceCalendarType": {
"title": "Calendar Type",
"type": "string",
"required": false,
"choices": [
{
"value": "none",
"title": "None"
},
{
"value": "microsoft",
"title": "Microsoft Exchange / Office 365"
},
{
"value": "google",
"title": "Google Calendar"
}
]
},
"newWorkspace": {
"title": "Create new workspace",
"type": "boolean",
"required": false
},
"personEmail": {
"title": "Person",
"type": "string",
"required": false
},
"mac": {
"title": "MAC Address",
"description": "MAC address in the form 112233445566",
"type": "string",
"required": true
},
"password": {
"title": "Password",
"type": "string",
"is_password": true,
"required": false
},
"template": {
"title": "Device Template",
"type": "string",
"required": false
},
"manufacturer": {
"type": "string",
"required": false
},
"deviceIsAta": {
"type": "boolean",
"required": false
},
"deviceIsMpp": {
"type": "boolean",
"required": false
},
"deviceIsWiFi": {
"type": "boolean",
"required": false
},
"supportedForPeople": {
"type": "boolean",
"required": false
},
"supportedForPlace": {
"type": "boolean",
"required": false
},
"custom_string_1": {
"title": "custom_string_1",
"type": "string"
},
"custom_string_2": {
"title": "custom_string_2",
"type": "string"
},
"custom_string_3": {
"title": "custom_string_3",
"type": "string"
},
"custom_string_4": {
"title": "custom_string_4",
"type": "string"
},
"custom_string_5": {
"title": "custom_string_5",
"type": "string"
},
"custom_string_6": {
"title": "custom_string_6",
"type": "string"
},
"custom_string_7": {
"title": "custom_string_7",
"type": "string"
},
"custom_string_8": {
"title": "custom_string_8",
"type": "string"
},
"custom_string_9": {
"title": "custom_string_9",
"type": "string"
},
"custom_string_10": {
"title": "custom_string_10",
"type": "string"
},
"custom_boolean_1": {
"title": "custom_boolean_1",
"type": "boolean"
},
"custom_boolean_2": {
"title": "custom_boolean_2",
"type": "boolean"
},
"custom_boolean_3": {
"title": "custom_boolean_3",
"type": "boolean"
},
"custom_boolean_4": {
"title": "custom_boolean_4",
"type": "boolean"
},
"custom_boolean_5": {
"title": "custom_boolean_5",
"type": "boolean"
},
"custom_boolean_6": {
"title": "custom_boolean_6",
"type": "boolean"
},
"custom_boolean_7": {
"title": "custom_boolean_7",
"type": "boolean"
},
"custom_boolean_8": {
"title": "custom_boolean_8",
"type": "boolean"
},
"custom_boolean_9": {
"title": "custom_boolean_9",
"type": "boolean"
},
"custom_boolean_10": {
"title": "custom_boolean_10",
"type": "boolean"
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/QuickAddWebexDevice/add/ |
|
The GUI Add form of view/QuickAddWebexDevice 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/view/QuickAddWebexDevice | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]shows the View resource has no instance pkid, because a view model stores no instances.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for view/QuickAddWebexDevice | POST | /api/view/QuickAddWebexDevice/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/view/QuickAddWebexDevice/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/view/QuickAddWebexDevice/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]