[Index]

API Reference for data/HcsCommandDAT

HcsCommandDAT

Model ref.: data/HcsCommandDAT

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

Bulk Delete

Task Call URL Parameters Payload
Bulk delete [pkid1],[pkid2]... DELETE /api/data/HcsCommandDAT/ hierarchy=[hierarchy] {"hrefs":["/api/data/HcsCommandDAT/[pkid1]", "/api/data/HcsCommandDAT/[pkid2]", ...]}
  • For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: data/HcsCommandDAT
    GET http://[host-proxy]/api/data/HcsCommandDAT/?hierarchy=[hierarchy]&format=json

Bulk Export

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/
  • hierarchy=[hierarchy]
  • version=[version]
  • schema=
  • schema_rules=
  • template_name=[configtemplate]
  • export_format=[raw_xlsx|xlsx|json]
{ "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.

  • To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for data/HcsCommandDAT:
  •  GET http://[host-proxy]/api/data/HcsCommandDAT/?hierarchy=[hierarchy]

Export Bulk Load Template

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/
  • hierarchy=[hierarchy]
  • modeltype=data/HcsCommandDAT
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

List

Task Call URL Parameters Response
List GET /api/data/HcsCommandDAT/
  • hierarchy=[hierarchy]
  • format=json
  • schema=true
The data/HcsCommandDAT schema and all instances as JSON.

(The list will return 0 to 3 data/HcsCommandDAT instances)

Help

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

Instance API Reference

Modify

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.

Delete

Task Call URL Parameters Response
Delete DELETE /api/data/HcsCommandDAT/[pkid] hierarchy=[hierarchy]

Import

Task Call URL Parameters Payload
Import POST /api/data/HcsCommandDAT/[pkid]/import hierarchy=[hierarchy] If payload required:

Export

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
  • hierarchy=[hierarchy]
  • version=[version]
  • schema=
  • schema_rules=
  • template_name=[configtemplate]
  • export_format=[raw_xlsx|xlsx|json]
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.

Get

Task Call URL Parameters Response
Get GET /api/data/HcsCommandDAT/[pkid] hierarchy=[hierarchy] The data/HcsCommandDAT instance with [pkid].

Help

Task Call URL Parameters Response
Help GET /api/data/HcsCommandDAT/[pkid]/help hierarchy=[hierarchy] The on-line Help for data/HcsCommandDAT.