Dataset Export

Every exportable Dataset shares this export endpoint. Open it from a Dataset's Export card — the Dataset name is passed in the URL and filled in below. The export uses the same filters as that Dataset's query; see the linked query endpoint for the available filter fields.

GEThttps://b-api.longbridge.xyz/v1/datasets/{name}/download

Current Dataset:

Open this page from a Dataset's Export card to target a specific Dataset.

Filters

The export reuses the same filters as the Dataset query. See the query endpoint for the full filter reference:

Open the query endpoint →

Export options application/json

modeinteger

Mode. Defaults to 0 (synchronous mode) when omitted.

Allowed values:

0 - Sync
1 - Async

01

extstring

Ext. Download file format. Defaults to csv when omitted.

Allowed values:

csv - CSV
xlsx - Excel

csvxlsx

file_namestring

File Name. Export file name. The server generates a name when omitted.

down_fieldsarray<string>

Down Fields. When omitted, all fields are exported; allowed values are listed under items.enum (the same field list as the query endpoint's data.list.items).

ticket_contentstring

Ticket Content. Information shown to the approver when download approval is enabled for the template.

ticket_preview_urlstring

Ticket Preview URL. Export approval detail URL. Used only when the export requires approval.

hideinteger

Hide. Whether to hide this export from the download-record list.

Allowed values:

0 - Not Hidden
1 - Hidden

01

Responses

HTTP 200On success, returns information about the Cash Account Details Export task. Synchronous exports provide a download URL directly; asynchronous exports provide file_download_id for subsequent status queries.

Standard response envelopecodemessagedata

dataobjectdata structure

urlstring

Download URL. Returned in synchronous mode (mode: 0); empty in asynchronous mode.

file_download_idstring

File Download ID. Returned in async mode (mode: 1); it is the {id} in GET /v1/datasets/download/{id} / DELETE /v1/datasets/download/{id}: GET obtains the final download URL, DELETE deletes the export record.

ticket_idstring

Ticket ID. Returned value: Approval ticket ID. Returned only when the operation starts an approval workflow.

HTTP 400Bad request. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

Export options application/json

Responses

Related