Export the data fields in any format

post https://api.dastra.eu/v1/ws/{workspaceId}/DataFields/export/{format}

Path Params

format

string

required

Supported export formats. Max size will depend on format

workspaceId

string

required

Body Params

useNativeColumn

boolean

cols

array of strings | null

cols

cats

array of strings | null

cats

types

array of strings | null

types

sensitive

boolean | null

string | null

ids

array of uuids | null

ids

select

string | null

Comma separated list of fields

page

int32

1 to 2147483647

Pagination index (1 based, page 1 = 1, page 2 = 2...)

size

int32

1 to 9999

Size of the result page (default: 20, max 500)

skip

int32 | null

The number of items to skip (if not provided, it will use the default page and size prop)

sortBy

string | null

The field to sort

asc

boolean

True to sort ascending

filters

string | null

A serialized as json filter string using the JsonRuleEngine.net format
https://github.com/antoinebidault/JsonRuleEngine.Net
The filters is a query param, that's why he must be properly serialized as a json string and url encoded
e.g. {"field":"ProcessingType", "operator":"notEqual", "value": "Done"}
The field prop must match one property name of the object (present in the output results)
The operator can be equal,
notEqual,
lessThan,
lessThanInclusive,
greaterThan,
greaterThanInclusive,
in,
notIn,
contains,
doesNotContains,
isNull,
isNotNull,
isEmpty
You can combine the filters as following :
{ "separator":"Or","rules": [{"field":"ProcessingType", "operator":"notEqual", "value": "Done"},{"field":"ProcessingType", "operator":"isNull"}]}
Serialize the filter param as following:
?filters=${uriEncodeComponent(JSON.stringify({"field":"ProcessingType", "operator":"notEqual", "value": "Done"}))}

Response

200

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.dastra.eu/v1/ws/workspaceId/DataFields/export/csv \
3
     --header 'content-type: application/*+json'

Click Try It! to start a request and see the response here!