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
Key | Datatype | Required | Description |
---|---|---|---|
q | string | ||
roleId | number | ||
teamId | number | ||
owner | boolean | ||
ids | number | ||
ids | number | ||
select | string | Comma separated list of fields | |
page | number | Pagination index (1 based, page 1 = 1, page 2 = 2...) | |
size | number | Size of the result page (default: 20, max 500) | |
skip | number | The number of items to skip (if not provided, it will use the default page and size prop) | |
sortBy | string | The field to sort | |
asc | boolean | True to sort ascending | |
filters | string | 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"}))} |
RESPONSES
status: OK
""