[Index]
Model ref.: device/cuc/AXLServer
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": {
"CcmVersion": {
"description": " The product version of the Cisco Unified Communications Manager switch.",
"title": "Ccm Version",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "CcmVersion"
},
"DisplayName": {
"minItems": 0,
"title": "Display Name",
"type": "string",
"description": " The name of the service. Used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration.",
"name": "DisplayName"
},
"Precedence": {
"minItems": 0,
"title": "Precedence",
"type": "integer",
"description": " A ranking of priority for rows in this table with identical [MediaSwitchObject, MediaPortGroupObjectId, MediaRemoteServiceEnum] in which connection is attempted to them, that is, as primary, secondary, etc.",
"name": "Precedence"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a MediaRemoteService object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"CcmAXLUser": {
"minItems": 0,
"title": "Ccm AXL User",
"type": "string",
"description": " The user name used to connect to AXL Web service on a Cisco Call Manager cluster.",
"name": "CcmAXLUser"
},
"TlsPort": {
"description": " The IP port at which the service is found. Cisco Unity Connection must negotiate a TLS session when using this port.",
"title": "Tls Port",
"minItems": 0,
"readonly": true,
"type": "integer",
"name": "TlsPort"
},
"IsPinSyncEnabled": {
"minItems": 0,
"title": "Is Pin Sync Enabled",
"type": "boolean",
"description": " A flag indicating whether AXL server has common PIN sync enabled or not.",
"name": "IsPinSyncEnabled"
},
"URI": {
"minItems": 0,
"title": "URI",
"type": "string",
"name": "URI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"Port": {
"minItems": 0,
"title": "Port",
"type": "integer",
"description": " The IP port at which the service is found.",
"name": "Port"
},
"PortGroupURI": {
"minItems": 0,
"title": "Port Group URI",
"type": "string",
"name": "PortGroupURI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"PhoneSystemURI": {
"minItems": 0,
"title": "Phone System URI",
"type": "string",
"name": "PhoneSystemURI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"MediaServerName": {
"description": " The preferred name of the media server, if applicable.",
"title": "Media Server Name",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "MediaServerName"
},
"HostOrIPAddress": {
"minItems": 0,
"title": "Host Or IP Address",
"type": "string",
"description": " The DNS name or IP address of the computer hosting the remote service .",
"name": "HostOrIPAddress"
},
"MediaPortGroupObjectId": {
"minItems": 0,
"title": "Media Port Group Object Id",
"type": "string",
"description": " The unique identifier of the MediaPortGroup object to which this row corresponds.",
"name": "MediaPortGroupObjectId"
},
"SkinnyStateMachineEnum": {
"description": " A flag indicating whether this MediaPortGroup is integrated with Cisco Unified Communications Manager or Cisco CallManager Express. This is used to switch on a special state engine in the Skinny TSP for Cisco CallManager Express.",
"title": "Skinny State Machine Enum",
"minItems": 0,
"readonly": true,
"type": "integer",
"name": "SkinnyStateMachineEnum"
},
"CcmAXLPassword": {
"is_password": true,
"description": " The password (encrypted) for the CcmAXLUser used to connect to a AXL Web service on a Cisco Call Manager cluster.",
"title": "Ccm AXL Password",
"minItems": 0,
"type": "string",
"name": "CcmAXLPassword"
},
"MediaRemoteServiceEnum": {
"description": " The type of IP service.",
"title": "Media Remote Service Enum",
"minItems": 0,
"readonly": true,
"type": "integer",
"name": "MediaRemoteServiceEnum"
},
"MediaSwitchObjectId": {
"target": "/api/device/cuc/PhoneSystem/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": true,
"name": "MediaSwitchObjectId",
"target_attr": "ObjectId",
"title": "Media Switch Object Id",
"type": [
"string"
],
"description": " The unique identifier of the MediaSwitch object to which this row corresponds. - template parameter [1]",
"target_model_type": "device/cuc/PhoneSystem",
"choices": []
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/cuc/AXLServer/add/ |
|
The GUI Add form of device/cuc/AXLServer 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/device/cuc/AXLServer | 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/device/cuc/AXLServer/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/AXLServer/[pkid1]", "/api/device/cuc/AXLServer/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/AXLServer/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/AXLServer/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/AXLServer/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/AXLServer/[pkid1]", "/api/v0/device/cuc/AXLServer/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/AXLServer/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cuc/AXLServer |
|
{"hrefs": ["/api/device/cuc/AXLServer/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/AXLServer |
|
{"hrefs": ["/api/device/cuc/AXLServer/[pkid1]", "/api/device/cuc/AXLServer/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/AXLServer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/AXLServer/export/ |
|
{ "hrefs":["/api/device/cuc/AXLServer/[pkid1]", "/api/device/cuc/AXLServer/[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 device/cuc/AXLServer and the JSON format can be used to import instances of device/cuc/AXLServer.
GET http://[host-proxy]/api/device/cuc/AXLServer/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/AXLServer | POST | /api/device/cuc/AXLServer/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/cuc/AXLServer/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/cuc/AXLServer/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/AXLServer/ |
|
The device/cuc/AXLServer schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/AXLServer instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 1,
"total_limit": null,
"order_by": "DisplayName",
"direction": "asc",
"current": "/api/device/cuc/AXLServer/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=down"
},
"operations": [
"move"
],
"meta": {
"model_type": "device/cuc/AXLServer",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"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": []
},
"model_specific_actions": [
"add",
"list",
"update",
"get",
"remove",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"schema_version": "14.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/device/cuc/AXLServer/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cuc/AXLServer/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/cuc/AXLServer/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/AXLServer",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/cuc/AXLServer/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/device/cuc/AXLServer/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/cuc/AXLServer/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/cuc/AXLServer/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/cuc/AXLServer/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/AXLServer/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/AXLServer/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"resources": [
{
"data": {
"IsPinSyncEnabled": false,
"Precedence": 0,
"ObjectId": "cd13c336-f095-4834-9eac-36950c3ca370",
"CcmAXLUser": "ccmadmin",
"MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876",
"TlsPort": 0,
"CcmVersion": "5",
"URI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876/axlservers/cd13c336-f095-4834-9eac-36950c3ca370",
"PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876",
"HostOrIPAddress": "192.168.100.15",
"SkinnyStateMachineEnum": 10,
"MediaRemoteServiceEnum": 103,
"Port": 8443,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cuc/AXLServer",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/device/cuc/AXLServer/6679715b770d07b8daf14167/",
"pkid": "6679715b770d07b8daf14167"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"6679715b770d07b8daf14167"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cuc/AXLServer/6679715b770d07b8daf14167/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cuc/AXLServer/6679715b770d07b8daf14167/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/AXLServer/6679715b770d07b8daf14167/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/6679715b770d07b8daf14167/?model_type=device/cuc/AXLServer",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/AXLServer/6679715b770d07b8daf14167/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/AXLServer/6679715b770d07b8daf14167/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/AXLServer/6679715b770d07b8daf14167/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/AXLServer/6679715b770d07b8daf14167/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "6679715b770d07b8daf14167"
}
]
}
(Show the first instance)
{
"data": {
"IsPinSyncEnabled": false,
"Precedence": 0,
"ObjectId": "cd13c336-f095-4834-9eac-36950c3ca370",
"CcmAXLUser": "ccmadmin",
"MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876",
"TlsPort": 0,
"CcmVersion": "5",
"URI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876/axlservers/cd13c336-f095-4834-9eac-36950c3ca370",
"PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876",
"HostOrIPAddress": "192.168.100.15",
"SkinnyStateMachineEnum": 10,
"MediaRemoteServiceEnum": 103,
"Port": 8443
},
"meta": {
"model_type": "device/cuc/AXLServer",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"parent": [
{
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523",
"pkid": "5ae89ea2affa931cce38a523"
}
],
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"children": [],
"self": [
{
"href": "/api/device/cuc/AXLServer/6679715b770d07b8daf14167/",
"pkid": "6679715b770d07b8daf14167"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"6679715b770d07b8daf14167"
],
"schema_version": "11.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cuc/AXLServer/6679715b770d07b8daf14167/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cuc/AXLServer/6679715b770d07b8daf14167/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/AXLServer/6679715b770d07b8daf14167/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/6679715b770d07b8daf14167/?hierarchy=[hierarchy]&model_type=device/cuc/AXLServer",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/AXLServer/6679715b770d07b8daf14167/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/AXLServer/6679715b770d07b8daf14167/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/AXLServer/6679715b770d07b8daf14167/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/AXLServer/6679715b770d07b8daf14167/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"pkid": "6679715b770d07b8daf14167"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/AXLServer. | GET | /api/device/cuc/AXLServer/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/AXLServer as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/AXLServer/purge/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/AXLServer/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/cuc/AXLServer/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/AXLServer/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/AXLServer/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/AXLServer | 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 device/cuc/AXLServer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/AXLServer/[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 device/cuc/AXLServer and the JSON format can be used to import instances of device/cuc/AXLServer.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/AXLServer/[pkid] | hierarchy=[hierarchy] | The device/cuc/AXLServer instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/AXLServer/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/AXLServer. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/AXLServer/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |