Get a paginated list of projects
GET {{baseUrl}}/v1/ws/:workspaceId/Projects?ids=d4f4baa2-55ee-3f4c-0ca0-c6deaeed0857&ids=urn:uuid:ff11db24-69a8-3ad2-d3e2-f5cb64653a1d&q=eu&archived=true&select=eu&page=61551403&size=61551403&skip=61551403&sortBy=eu&asc=true&filters=eu
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
ids | string | ||
ids | string | ||
q | string | ||
archived | boolean | ||
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 labore exercitation in","nbTasks":71452835,"tasks":[{"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":"urn:uuid:af06ff13-0115-bfe8-6d4d-267712fef1e3","archived":true,"dateUpdate":"1944-02-09T03:28:48.359Z","dateCreation":"1991-08-06T16:11:27.867Z","description":"qui"},{"label":"eiusmod ipsum est ex se","nbTasks":-57640990,"tasks":[{"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":"urn:uuid:724b8832-d2f0-14fe-f789-a60080dd5b89","archived":true,"dateUpdate":"2020-03-15T14:03:01.460Z","dateCreation":"1991-04-12T02:43:41.379Z","description":"cillum et anim Ut sunt"}],"total":69937085,"size":-94611721,"page":-98424549}