[Index]
Model ref.: relation/HcsWebExREL
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": {
"protocol": {
"choices": [
{
"value": "https",
"title": "https"
},
{
"value": "http",
"title": "http"
}
],
"required": true,
"type": "string",
"description": "The protocol that is used for communication with the WebEx server.",
"title": "Protocol"
},
"version": {
"choices": [
{
"value": "6.0",
"title": "27.00"
},
{
"value": "8.0",
"title": "29.13"
}
],
"required": true,
"type": "string",
"description": "Supported WebEx server versions.",
"title": "Version"
},
"partner_id": {
"required": false,
"type": "string",
"description": "Partner ID, typically received from the Cisco WebEx Site Provisioning group.",
"title": "Partner Id"
},
"webex_id": {
"required": false,
"type": "string",
"description": "The WebEx Id of an administrator of the site. This used to connect to the server for administrative tasks such as adding/deleting users.",
"title": "WebEx Id"
},
"site_id": {
"required": false,
"type": "string",
"description": "An Id for the site being managed, typically received from the Cisco WebEx Site Provisioning group. This field is mandatory if Site Name is not specified.",
"title": "Site Id"
},
"partner_credentials_override": {
"description": "Partner credentials to use for this set of connection parameters",
"title": "Partner Credentials",
"format": "uri",
"choices": [],
"target_attr": "name",
"target_model_type": "data/WebExPartnerCredentials",
"type": "string",
"target": "/api/data/WebExPartnerCredentials/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"rest_uri": {
"required": true,
"type": "string",
"description": "The relative URI of the XML service of the WebEx server eg. WBXService/XMLService",
"title": "REST URI"
},
"email": {
"required": false,
"type": "string",
"description": "A valid email for the administrator. Required if no WebEx Id is provided.",
"title": "Email"
},
"address": {
"required": true,
"type": "string",
"description": "The address of the WebEx server eg. site-name.webex.com.",
"title": "Address"
},
"site_name": {
"required": false,
"type": "string",
"description": "The name of the site to be managed which is typically the same as the WebEx address prefix. This field is mandatory if Site ID is not specified.",
"title": "Site Name"
},
"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"
},
"password": {
"is_password": true,
"description": "The password for the administrator with the supplied WebEx Id.",
"title": "Password",
"required": false,
"store_encrypted": true,
"type": "string"
},
"type": {
"choices": [
{
"value": "cloudbased",
"title": "Cloud-Based"
}
],
"required": true,
"type": "string",
"description": "The type of WebEx server. Can be 'Cloud-Based'.",
"title": "Type"
},
"port": {
"required": false,
"type": "string",
"description": "The port that is used for communication with the WebEx server.",
"title": "Port"
}
},
"schema_version": "2.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsWebExREL/add/ |
|
The GUI Add form of relation/HcsWebExREL 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/HcsWebExREL/ | 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/HcsWebExREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsWebExREL/[pkid1]", "/api/relation/HcsWebExREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsWebExREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsWebExREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsWebExREL/export/ |
|
{ "hrefs":["/api/relation/HcsWebExREL/[pkid1]", "/api/relation/HcsWebExREL/[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/HcsWebExREL and the JSON format can be used to import instances of relation/HcsWebExREL.
GET http://[host-proxy]/api/relation/HcsWebExREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsWebExREL | POST | /api/relation/HcsWebExREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsWebExREL/ |
|
The relation/HcsWebExREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsWebExREL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "protocol",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/HcsWebExREL/?skip=0&limit=3&order_by=protocol&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 2
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/HcsWebExREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/HcsWebExREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsWebExREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsWebExREL/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/HcsWebExREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/HcsWebExREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsWebExREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsWebExREL",
"model_specific_actions": [
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"export"
],
"summary_attrs": [
{
"name": "protocol",
"title": "Protocol"
},
{
"name": "address",
"title": "Address"
},
{
"name": "port",
"title": "Port"
},
{
"name": "site_name",
"title": "Site Name"
},
{
"name": "rest_uri",
"title": "REST URI"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "6109c07fe04a4a00149d6fe3",
"meta": {
"tags": [],
"cached": true,
"title": "https - nsite-dev.webex.com - 443",
"business_key": {
"hierarchy": true,
"unique": [
"protocol",
"address",
"port"
]
},
"schema_version": "0.1.9",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6109c07fe04a4a00149d6fe3",
"href": "/api/relation/HcsWebExREL/6109c07fe04a4a00149d6fe3/"
}
],
"parent": [
{
"pkid": "6109bff5e04a4a00149d4e1d",
"href": "/api/data/HierarchyNode/6109bff5e04a4a00149d4e1d"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsWebExREL/6109c07fe04a4a00149d6fe3/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsWebExREL/6109c07fe04a4a00149d6fe3/",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsWebExREL/6109c07fe04a4a00149d6fe3/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsWebExREL/6109c07fe04a4a00149d6fe3/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsWebExREL/6109c07fe04a4a00149d6fe3/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsWebExREL",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c07fe04a4a00149d6fe3"
],
"summary_attrs": [
{
"name": "protocol",
"title": "Protocol"
},
{
"name": "address",
"title": "Address"
},
{
"name": "port",
"title": "Port"
},
{
"name": "site_name",
"title": "Site Name"
},
{
"name": "rest_uri",
"title": "REST URI"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"site_name": "nsite-dev",
"pkid": "6109c080e04a4a00149d6fe5",
"webex_id": "voss",
"rest_uri": "WBXService/XMLService",
"version": "6.0",
"address": "nsite-dev.webex.com",
"protocol": "https",
"hierarchy_friendly_name": "CS-P (Provider)",
"password": "==$DWUooK6Lu0js7cQA$dw+LxlXr$==",
"type": "cloudbased",
"port": "443",
"hierarchy_path": "sys.hcs.CS-P"
}
},
{
"pkid": "6109c0cae04a4a00149d7f9e",
"meta": {
"tags": [],
"cached": true,
"title": "https - nsite-dev.webex.com - 443",
"business_key": {
"hierarchy": true,
"unique": [
"protocol",
"address",
"port"
]
},
"schema_version": "0.1.9",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6109c0cae04a4a00149d7f9e",
"href": "/api/relation/HcsWebExREL/6109c0cae04a4a00149d7f9e/"
}
],
"parent": [
{
"pkid": "6109c040e04a4a00149d61cf",
"href": "/api/data/HierarchyNode/6109c040e04a4a00149d61cf"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/relation/HcsWebExREL/6109c0cae04a4a00149d7f9e/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/relation/HcsWebExREL/6109c0cae04a4a00149d7f9e/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsWebExREL/6109c0cae04a4a00149d7f9e/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/relation/HcsWebExREL/6109c0cae04a4a00149d7f9e/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/relation/HcsWebExREL/6109c0cae04a4a00149d7f9e/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "relation/HcsWebExREL",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c032e04a4a00149d5e4d",
"6109c040e04a4a00149d61cf",
"6109c0cae04a4a00149d7f9e"
],
"summary_attrs": [
{
"name": "protocol",
"title": "Protocol"
},
{
"name": "address",
"title": "Address"
},
{
"name": "port",
"title": "Port"
},
{
"name": "site_name",
"title": "Site Name"
},
{
"name": "rest_uri",
"title": "REST URI"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"site_name": "nsite-dev",
"pkid": "6109c0cae04a4a00149d7fa0",
"webex_id": "voss",
"rest_uri": "WBXService/XMLService",
"version": "6.0",
"address": "nsite-dev.webex.com",
"protocol": "https",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"password": "==$CYDH231Bq9OozsGA$/9PDjmuM$==",
"type": "cloudbased",
"port": "443",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "6109c07fe04a4a00149d6fe3",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "https",
"business_key": {},
"schema_version": "2.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": "6109c07fe04a4a00149d6fe3",
"href": "/api/relation/HcsWebExREL/6109c07fe04a4a00149d6fe3/"
}
],
"children": [],
"parent": [
{
"pkid": "6109bff5e04a4a00149d4e1d",
"href": "/api/data/HierarchyNode/6109bff5e04a4a00149d4e1d"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsWebExREL/6109c07fe04a4a00149d6fe3/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsWebExREL/6109c07fe04a4a00149d6fe3/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsWebExREL/6109c07fe04a4a00149d6fe3/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsWebExREL/6109c07fe04a4a00149d6fe3/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsWebExREL/6109c07fe04a4a00149d6fe3/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsWebExREL",
"summary_attrs": [
{
"name": "protocol",
"title": "Protocol"
},
{
"name": "address",
"title": "Address"
},
{
"name": "port",
"title": "Port"
},
{
"name": "site_name",
"title": "Site Name"
},
{
"name": "rest_uri",
"title": "REST URI"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"site_name": "nsite-dev",
"webex_id": "voss",
"rest_uri": "WBXService/XMLService",
"version": "6.0",
"address": "nsite-dev.webex.com",
"protocol": "https",
"shadow": [],
"password": "==$DWUooK6Lu0js7cQA$dw+LxlXr$==",
"type": "cloudbased",
"port": "443"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsWebExREL. | GET | /api/relation/HcsWebExREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsWebExREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsWebExREL/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsWebExREL/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsWebExREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsWebExREL/[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/HcsWebExREL and the JSON format can be used to import instances of relation/HcsWebExREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsWebExREL/[pkid]/ | hierarchy=[hierarchy] | The relation/HcsWebExREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsWebExREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsWebExREL. |