Export BulkLoad Template Generic Action#

Action

export_bulkload_template

Title

Get a compressed file of the Bulk Load spread sheet template for the resource, optionally with a Field Display Policy as [policy] or Configuration Template as [configtemplate].

Method

POST

URL

/api/<resource_type>/<resource_name>/export_bulkload_template/

Parameters

hierarchy=[hierarchy], policy_name=[field_display_policy], template_name=[configtemplate], schema=, schema_rules=

Response

The response is an attachment of the format: <resource_type>_<resource_name>_bulkloadsheet.xlsx

support_async

true

Class

export

Example request:

POST /api/data/DATA1/export_bulkload_template/
 ?hierarchy=[hierarchy]
 &template_name=[configtemplate]
 &policy_name=[field_display_policy]
 &schema=
 &schema_rules=
 &format=json

Example response:

HTTP/1.1 200 OK
Server: nginx/1.1.19
Date: Mon, 09 Mar 2015 15:13:06 GMT
Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Transfer-Encoding: chunked
Connection: keep-alive
Vary: Accept, Cookie, Accept-Language
Content-Language: en-us
Allow: POST, OPTIONS
Content-Disposition: attachment; filename=data_DATA1_bulkloadsheet.xlsx

The returned spreadsheet will reflect the applied Configuration Template and Field Display Policy as indicated in the POST parameters.