Qodex.ai

Get the workspaces list

GET {{baseUrl}}/v1/WorkSpaces?page=61551403&size=61551403&skip=61551403&sortBy=eu&asc=true&filters=eu&q=eu&state=Active

Request Params

KeyDatatypeRequiredDescription
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"}))}
qstring
statestring

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"items":[{"label":"aute sed ut","id":1901222,"tenantId":70997981,"primaryColor":"sed occaecat voluptate","secondaryColor":"Ut nostrud anim commodo irure","logoUrl":"dolore qui Duis deserunt velit","state":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"permissions":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"roles":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"nbCustomFields":11813452,"customFields":{"DataProcessing":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Task":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Asset":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"SecurityMeasure":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataRetentionRule":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataField":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Actor":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataBreach":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"RiskEvaluation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataSubjectRequest":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"dataSubjectArchivedRetentionDays":18549097,"nbEntities":58799855,"dismissOnboardingGuide":true,"isLibrary":false},{"label":"mollit fugiat","id":-51424751,"tenantId":-30424413,"primaryColor":"laborum culpa dolor exercitation","secondaryColor":"non nisi consectetur sit","logoUrl":"ad laboris nulla laborum eiusmod","state":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"permissions":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"roles":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"nbCustomFields":-11330792,"customFields":{"DataProcessing":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Task":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Asset":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"SecurityMeasure":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataRetentionRule":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataField":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Actor":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataBreach":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"RiskEvaluation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataSubjectRequest":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"dataSubjectArchivedRetentionDays":-28974309,"nbEntities":-78563377,"dismissOnboardingGuide":false,"isLibrary":true}],"total":30120568,"size":52398399,"page":-69201903}