List data fields
GET {{baseUrl}}/v1/ws/:workspaceId/DataFields?cats=<string>&cats=<string>&types=Matrix&types=Matrix&sensitive=true&q=eu&page=61551403&size=61551403&skip=61551403&sortBy=eu&asc=true&filters=eu
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
cats | string | ||
cats | string | ||
types | string | ||
types | string | ||
sensitive | boolean | ||
q | string | ||
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"}))} |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"label":"nulla","id":"660e76b8-877e-64e4-959e-d68ccc2484ff","customFields":{"reprehenderitf":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"ref":"id sit eu laborum laboris","archivingPolicy":"magna enim fugiat do","required":true,"definition":"in velit","technicalDefinition":"elit dolore ea","sensitiveDataFieldLegalJustification":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sensitiveDataFieldLegalJustificationDescription":"minim anim dolore elit ","sensitiveData":false,"personalDataCategory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dataType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dateCreation":"1995-09-15T18:23:09.698Z","dateUpdate":"1992-04-17T21:57:23.805Z","creator":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"label":"cupidat","id":"0907aded-ade2-7135-dbbf-debf9b963997","customFields":{"velit8e":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"ut_a0":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"ref":"non voluptate","archivingPolicy":"amet","required":true,"definition":"in dolore nisi ex ut","technicalDefinition":"est","sensitiveDataFieldLegalJustification":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sensitiveDataFieldLegalJustificationDescription":"aliquip qui magna Excepteur","sensitiveData":true,"personalDataCategory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dataType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dateCreation":"1994-04-30T12:12:16.790Z","dateUpdate":"1994-03-03T04:13:16.905Z","creator":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"total":68490116,"size":-15989528,"page":43436869}