Export the users in csv,xlsx or json

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

Path Params

format

string

required

Supported export formats. Max size will depend on format

workspaceId

string

required

Query Params

string

length ≤ 250

roleId

int32

teamId

int32

owner

boolean

ids

array of int32s

ids

select

string

length ≤ 700

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

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

sortBy

string

length ≤ 100

The field to sort

asc

boolean

True to sort ascending

filters

string

length ≤ 3000

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"}))}

PaginationDisabled

boolean

Response

200

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.dastra.eu/v1/ws/workspaceId/Users/export/csv

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