Get all areas related to the workspace (Flatten)
<returns></returns>
GET {{baseUrl}}/v1/ws/:workspaceId/Areas?type=Entity&ref=eu&q=eu&parentId=61551403&select=eu&page=61551403&size=61551403&skip=61551403&sortBy=eu&asc=true&filters=eu
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
type | string | Filter by type | |
ref | string | Your internal reference filter | |
q | string | Full text search | |
parentId | number | Parent identifier to get all child of a specific organizational unit | |
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"}))} |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"label":"aliqua reprehenderit id c","order":-13257373,"children":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"teams":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"id":-74563557,"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"parentId":64814674,"ref":"deserunt id","description":"reprehenderit nostrud Excepteur aute","logoUrl":"ullamco fugiat commodo aliquip","address":"dolore tempor amet nostrud","zipCode":"","city":"velit qui ut incididunt","countryCode":"fug","immatriculationNumber":"eiusmod qui lab","phoneNumber":"aute min","mailAddress":"enim Ut irure id n","dpo":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"referent":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"representative":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dataProtectionAuthority":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"label":"enim sit","order":81242354,"children":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"teams":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"id":80059186,"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"parentId":-39991910,"ref":"culpa","description":"adipisicing Ut in","logoUrl":"reprehenderit adipisicing tempor no","address":"in in mollit non","zipCode":"","city":"incididunt consequat ea eu dolore","countryCode":"sun","immatriculationNumber":"in esse sint","phoneNumber":"","mailAddress":"cillum","dpo":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"referent":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"representative":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dataProtectionAuthority":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"total":-87529046,"size":88796067,"page":-61966442}