Export the records in csv,xlsx or json

POST {{baseUrl}}/v1/ws/:workspaceId/Users/export/:format?q=eu&roleId=61551403&teamId=61551403&owner=true&ids=88057944&ids=-17779712&select=eu&page=61551403&size=61551403&skip=61551403&sortBy=eu&asc=true&filters=eu

Request Params

KeyDatatypeRequiredDescription
qstring
roleIdnumber
teamIdnumber
ownerboolean
idsnumber
idsnumber
selectstringComma separated list of fields
pagenumberPagination index (1 based, page 1 = 1, page 2 = 2...)
sizenumberSize of the result page (default: 20, max 500)
skipnumberThe number of items to skip (if not provided, it will use the default page and size prop)
sortBystringThe field to sort
ascbooleanTrue to sort ascending
filtersstringA 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"}))}

RESPONSES

status: OK

""