...
Code Block |
---|
title | Example of a dumped export |
---|
collapse | true |
---|
|
{
"url": "/rest/projects/yufqzxkbiecj7jot/md/exports/g3v603i8m3tre30g",
"dumpTime": "2018-01-30T13:48:17Z",
"version": "8",
"content": {
"id": "g3v603i8m3tre30g",
"name": "customer_ids_export",
"type": "export",
"title": "List of Customer IDs",
"description": "Returns client IDs, Districts, Wards and indicators available in the view into CSV file.",
"content": {
"properties": [
"baskets.client_id",
"district.districtname",
"ward.wardname"
]
},
"accessInfo": {
"createdAt": "2017-11-13T14:12:57Z",
"modifiedAt": "2018-01-30T12:48:18Z"
},
"links": [
{
"rel": "self",
"href": "/rest/projects/yufqzxkbiecj7jot/md/exports/g3v603i8m3tre30g"
}
]
}
}
|
Additional syntax examples
Code Block |
---|
language | js |
---|
title | Export with output object |
---|
collapse | true |
---|
|
{
"name": "transaction_ids_export",
"type": "export",
"title": "List of Transaction IDs",
"description": "Returns transactions ID, postcodes, lower super output areas, middle super output areas and value of indicators available in the view into a file.",
"content": {
"properties": [
"codepoint_plg.msoa11nm",
"codepoint_plg.lsoa11nm",
"codepoint_plg.postcode",
"baskets.basket_id"
],
"output": {
"type": "file",
"format": "xlsx",
"filename": "Transaction IDs.csv"
"header": "basic"
}
}
} |
Key description
content
Key | Type | Optionality | Description | Constraints |
---|
properties | array | | array of dataset properties, which will be present in the exported file | {datasetName}.{datasetProperty} |
output | object | | export output settings |
|
content.output
Key | Type | Optionality | Description | Constraints |
---|
type | string | | output type (at the moment, only file is supported) | [file] |
format | string | | file format | [csv, xlsx] |
filename | string | | custom filename | (a-zA-Z0-9 _-)(.csv|.xlsx)
|
header | string | | header format | [basic, export, template] |
Visual representation
All project exports can be viewed in the export dialogoue. This dialogoue can is accessible by clicking the Menu button in the top left corner (), and selecting Export.
...