List all subject categories matching query
GET {{baseUrl}}/v1/ws/:workspaceId/SubjectCategories?q=eu&ids=d4f4baa2-55ee-3f4c-0ca0-c6deaeed0857&ids=urn:uuid:ff11db24-69a8-3ad2-d3e2-f5cb64653a1d&select=eu&page=61551403&size=61551403&skip=61551403&sortBy=eu&asc=true&filters=eu
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
q | string | ||
ids | string | ||
ids | string | ||
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
[{"label":"ea id","id":"urn:uuid:b0645b9a-6468-48e2-2849-933012082338","ref":"culpa et proident in elit","dateCreation":"1960-05-23T17:37:16.538Z","dateUpdate":"1993-08-17T19:40:57.957Z","creatorUserId":-60011142,"creatorUser":{"id":1132306,"displayName":"dolore","familyName":"laborum magna no","givenName":"consequat eu ipsum Ut","email":"voluptate","color":"qui veniam nostrud Ut","avatarUrl":"nisi mollit Ut","tenantId":-70869570},"description":"sit enim pariatur veniam","minorConcerned":true},{"label":"ad","id":"bcddd9a9-459e-9f7e-3172-7465d87a3676","ref":"laboris ut quis","dateCreation":"1989-12-12T05:37:36.317Z","dateUpdate":"2005-06-04T17:09:17.452Z","creatorUserId":22303809,"creatorUser":{"id":-54235159,"displayName":"enim nisi occaecat mollit","familyName":"in ut","givenName":"nostrud dolor aliqua dolor","email":"commodo nisi irure veniam in","color":"in velit eiusmod occaecat dolor","avatarUrl":"sunt consequat do pariatur laboris","tenantId":11482053},"description":"qui anim sit in","minorConcerned":false}]