[Index]
HcsCommandDAT
Model ref.: data/HcsCommandDAT
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": {
"deviceName": {
"is_password": false,
"description": "IOS Devices that the commands applies to",
"title": "Device Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"commands": {
"is_password": false,
"description": "commands triggered by the event",
"title": "Commands",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 4096,
"type": "string"
},
"gatewayName": {
"is_password": false,
"description": "Gateways that the command applies to",
"title": "Gateway Name",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"description": {
"is_password": false,
"description": "A description for the command set",
"title": "Description",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 4096,
"type": "string"
},
"timestamp": {
"is_password": false,
"description": "When the event occured",
"title": "Timestamp",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"applicableDevType": {
"is_password": false,
"description": "Applicable Device Type",
"title": "Device Type",
"required": true,
"displayable": false,
"choices": [
{
"value": "IOS_DEVICE",
"title": "IOS Device"
},
{
"value": "SIP_GATEWAY",
"title": "SIP Local Gateway"
},
{
"value": "ANALOG_GATEWAY",
"title": "Analog Gateway"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"commandBuilder": {
"is_password": false,
"description": "Command Builder name",
"title": "Command Builder",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"deviceDeleted": {
"is_password": false,
"description": "Indicates whether or not the assoicated device has been deleted",
"title": "Device Deleted",
"default": "false",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
}
},
"schema_version": "2.3"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/HcsCommandDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsCommandDAT/[pkid1]", "/api/data/HcsCommandDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsCommandDAT/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/HcsCommandDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/HcsCommandDAT/export/ |
|
{ "hrefs":["/api/data/HcsCommandDAT/[pkid1]", "/api/data/HcsCommandDAT/[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 data/HcsCommandDAT and the JSON format can be used to import instances of data/HcsCommandDAT.
GET http://[host-proxy]/api/data/HcsCommandDAT/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/HcsCommandDAT | POST | /api/data/HcsCommandDAT/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/HcsCommandDAT/ |
|
The data/HcsCommandDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsCommandDAT instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "timestamp",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/HcsCommandDAT/?skip=0&limit=3&order_by=timestamp&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 10
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.3",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsCommandDAT/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsCommandDAT/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/data/HcsCommandDAT/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/HcsCommandDAT/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsCommandDAT/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsCommandDAT",
"model_specific_actions": [
"list",
"get",
"update",
"remove",
"import",
"help",
"export",
"export_bulkload_template",
"help"
],
"summary_attrs": [
{
"name": "timestamp",
"title": "Timestamp"
},
{
"name": "deviceName",
"title": "Device Name"
},
{
"name": "gatewayName",
"title": "Gateway Name"
},
{
"name": "commandBuilder",
"title": "Command Builder"
},
{
"name": "description",
"title": "Description"
},
{
"name": "deviceDeleted",
"title": "Device Deleted"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "6305c8fcc46e74b46889da98",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.3",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6305c8fcc46e74b46889da98",
"href": "/api/data/HcsCommandDAT/6305c8fcc46e74b46889da98/"
}
],
"parent": [
{
"pkid": "63054c4fc46e74b4687bc91b",
"href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsCommandDAT/6305c8fcc46e74b46889da98/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsCommandDAT/6305c8fcc46e74b46889da98/",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsCommandDAT/6305c8fcc46e74b46889da98/import/",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsCommandDAT/6305c8fcc46e74b46889da98/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsCommandDAT/6305c8fcc46e74b46889da98/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsCommandDAT/6305c8fcc46e74b46889da98/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsCommandDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"63054c4fc46e74b4687bc91b",
"6305c8fcc46e74b46889da98"
],
"summary_attrs": [
{
"name": "timestamp",
"title": "Timestamp"
},
{
"name": "deviceName",
"title": "Device Name"
},
{
"name": "gatewayName",
"title": "Gateway Name"
},
{
"name": "commandBuilder",
"title": "Command Builder"
},
{
"name": "description",
"title": "Description"
},
{
"name": "deviceDeleted",
"title": "Device Deleted"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"deviceName": "IOS1000",
"commands": "conf t\nvoice service voip \nno ip address trusted authenticate\ny\nfax protocol t38 ls-redundancy 0 hs-redundancy 0 fallback pass-through g711ulaw\nmodem passthrough nse codec g711ulaw \nvoice class codec 1\ncodec preference 1 g729r8 bytes 30\ncodec preference 2 g711ulaw\ncodec preference 3 g711alaw\nend",
"gatewayName": "",
"description": "Command Builder for adding an IOS device",
"pkid": "6305c8fcc46e74b46889da99",
"timestamp": "2022-08-24 08:45:16.609556",
"applicableDevType": "IOS_DEVICE",
"commandBuilder": "addIOSDevice",
"deviceDeleted": false,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "6305c904c46e74b46889db88",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.3",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6305c904c46e74b46889db88",
"href": "/api/data/HcsCommandDAT/6305c904c46e74b46889db88/"
}
],
"parent": [
{
"pkid": "63054c4fc46e74b4687bc91b",
"href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/data/HcsCommandDAT/6305c904c46e74b46889db88/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/data/HcsCommandDAT/6305c904c46e74b46889db88/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"import": {
"support_async": true,
"href": "/api/data/HcsCommandDAT/6305c904c46e74b46889db88/import/",
"title": "Import",
"method": "POST",
"class": "import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsCommandDAT/6305c904c46e74b46889db88/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/data/HcsCommandDAT/6305c904c46e74b46889db88/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/data/HcsCommandDAT/6305c904c46e74b46889db88/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "data/HcsCommandDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"63054c4fc46e74b4687bc91b",
"6305c904c46e74b46889db88"
],
"summary_attrs": [
{
"name": "timestamp",
"title": "Timestamp"
},
{
"name": "deviceName",
"title": "Device Name"
},
{
"name": "gatewayName",
"title": "Gateway Name"
},
{
"name": "commandBuilder",
"title": "Command Builder"
},
{
"name": "description",
"title": "Description"
},
{
"name": "deviceDeleted",
"title": "Device Deleted"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"deviceName": "IOS2000",
"commands": "conf t\nvoice service voip \nno ip address trusted authenticate\ny\nfax protocol t38 ls-redundancy 0 hs-redundancy 0 fallback pass-through g711ulaw\nmodem passthrough nse codec g711ulaw \nvoice class codec 1\ncodec preference 1 g729r8 bytes 30\ncodec preference 2 g711ulaw\ncodec preference 3 g711alaw\nend",
"gatewayName": "",
"description": "Command Builder for adding an IOS device",
"pkid": "6305c904c46e74b46889db89",
"timestamp": "2022-08-24 08:45:24.407020",
"applicableDevType": "IOS_DEVICE",
"commandBuilder": "addIOSDevice",
"deviceDeleted": false,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "6305c98bc46e74b46889e569",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.3",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6305c98bc46e74b46889e569",
"href": "/api/data/HcsCommandDAT/6305c98bc46e74b46889e569/"
}
],
"parent": [
{
"pkid": "6305501dc46e74b4687ccdf9",
"href": "/api/data/HierarchyNode/6305501dc46e74b4687ccdf9"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/data/HcsCommandDAT/6305c98bc46e74b46889e569/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/data/HcsCommandDAT/6305c98bc46e74b46889e569/",
"class": "delete",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"class": "import",
"href": "/api/data/HcsCommandDAT/6305c98bc46e74b46889e569/import/",
"method": "POST",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/data/HcsCommandDAT/6305c98bc46e74b46889e569/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/data/HcsCommandDAT/6305c98bc46e74b46889e569/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/data/HcsCommandDAT/6305c98bc46e74b46889e569/help",
"class": "help",
"title": "Help"
}
}
],
"model_type": "data/HcsCommandDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"63054c4fc46e74b4687bc91b",
"6305501dc46e74b4687ccdf9",
"6305c98bc46e74b46889e569"
],
"summary_attrs": [
{
"name": "timestamp",
"title": "Timestamp"
},
{
"name": "deviceName",
"title": "Device Name"
},
{
"name": "gatewayName",
"title": "Gateway Name"
},
{
"name": "commandBuilder",
"title": "Command Builder"
},
{
"name": "description",
"title": "Description"
},
{
"name": "deviceDeleted",
"title": "Device Deleted"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"deviceName": "IOS1000",
"commands": "conf t\nstcapp ccm-group 1 \nstcapp \nstcapp feature access-code \nstcapp feature speed-dial \nsccp local FastEthernet0/0\nsccp \nccm-manager fax protocol cisco \nsccp ccm cucm identifier 1 version 7.0+\nsccp ccm group 1\nbind interface FastEthernet0/0\nassociate ccm 1 priority 1\nccm-manager config server 192.168.100.15\nccm-manager sccp local FastEthernet0/0\nccm-manager sccp \nstcapp \nend",
"gatewayName": "SKIGWEEEEE0400A",
"description": "Command Builder for adding an Analog Gateway",
"pkid": "6305c98bc46e74b46889e56a",
"timestamp": "2022-08-24 08:47:38.189000",
"applicableDevType": "ANALOG_GATEWAY",
"commandBuilder": "addAnalogGateway",
"deviceDeleted": true,
"hierarchy_friendly_name": "LOC001 (Site)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal.LOC001"
}
}
]
}
(Show the first instance)
{
"pkid": "6305c8fcc46e74b46889da98",
"meta": {
"tags": [],
"cached": false,
"title": "title format",
"business_key": {},
"schema_version": "2.3",
"references": {
"parent": [
{
"pkid": "63054c4fc46e74b4687bc91b",
"href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b"
}
],
"self": [
{
"pkid": "6305c8fcc46e74b46889da98",
"href": "/api/data/HcsCommandDAT/6305c8fcc46e74b46889da98/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsCommandDAT/6305c8fcc46e74b46889da98/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsCommandDAT/6305c8fcc46e74b46889da98/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsCommandDAT/6305c8fcc46e74b46889da98/import/?hierarchy=[hierarchy]",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsCommandDAT/6305c8fcc46e74b46889da98/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsCommandDAT/6305c8fcc46e74b46889da98/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsCommandDAT/6305c8fcc46e74b46889da98/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsCommandDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"63054c4fc46e74b4687bc91b",
"6305c8fcc46e74b46889da98"
],
"summary_attrs": [
{
"name": "timestamp",
"title": "Timestamp"
},
{
"name": "deviceName",
"title": "Device Name"
},
{
"name": "gatewayName",
"title": "Gateway Name"
},
{
"name": "commandBuilder",
"title": "Command Builder"
},
{
"name": "description",
"title": "Description"
},
{
"name": "deviceDeleted",
"title": "Device Deleted"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"deviceName": "IOS1000",
"commands": "conf t\nvoice service voip \nno ip address trusted authenticate\ny\nfax protocol t38 ls-redundancy 0 hs-redundancy 0 fallback pass-through g711ulaw\nmodem passthrough nse codec g711ulaw \nvoice class codec 1\ncodec preference 1 g729r8 bytes 30\ncodec preference 2 g711ulaw\ncodec preference 3 g711alaw\nend",
"gatewayName": "",
"description": "Command Builder for adding an IOS device",
"pkid": "6305c8fcc46e74b46889da99",
"timestamp": "2022-08-24 08:45:16.609556",
"applicableDevType": "IOS_DEVICE",
"commandBuilder": "addIOSDevice",
"deviceDeleted": false
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/HcsCommandDAT. | GET | /api/data/HcsCommandDAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/HcsCommandDAT as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/HcsCommandDAT/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/HcsCommandDAT/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/HcsCommandDAT/[pkid]/import/ | 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 data/HcsCommandDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/HcsCommandDAT/[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 data/HcsCommandDAT and the JSON format can be used to import instances of data/HcsCommandDAT.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/HcsCommandDAT/[pkid]/ | hierarchy=[hierarchy] | The data/HcsCommandDAT instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/HcsCommandDAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/HcsCommandDAT. |