Qodex.ai

Get all actors (User inserted in the record of processing activities)

GET {{baseUrl}}/v1/ws/:workspaceId/Actors?ids=88057944&ids=-17779712&includeScore=true&q=eu&tags=88057944&tags=-17779712&countries=in in consectetur eni&countries=est elit ad&referencedAs=Vendor&types=Morale&types=Physical&select=eu&page=61551403&size=61551403&skip=61551403&sortBy=eu&asc=true&filters=eu

Allows you to retrieve all actors in workspace with a predefined filter query

Request Params

KeyDatatypeRequiredDescription
idsnumber
idsnumber
includeScoreboolean
qstring
tagsnumber
tagsnumber
countriesstring
countriesstring
referencedAsstring
typesstring
typesstring
selectstringComma separated list of fields
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"}))}

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"items":[{"customFields":{"aliqua_54_":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"attachments":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"tags":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"recipients":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"creator":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"assets":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"subsequentProcessors":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"dpaSignatureDate":"1984-12-20T20:13:35.491Z","nbReferences":-81882243,"subsequentProcessorCountryCodes":"magna qui ex labore eiusmod","id":82137892,"ref":"voluptate minim dolore sit qui","displayName":"ut voluptate velit enim nostrud","dateCreation":"1984-01-20T19:18:05.357Z","dateUpdate":"1980-06-07T22:19:46.096Z","logoUrl":"proident pariatur id officia","actorType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"vendorType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"accessLevel":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"givenName":"sed ipsum occaecat","familyName":"voluptate","companyName":"ut magna nisi id est","description":"minim aute consectetur culpa","countryCode":"qu","readonly":false,"email":"eiusmod non aute eu","phoneNumber":"ad minim t","contactName":"Ut tempor reprehenderit","contactPosition":"qui nisi esse","immatriculationNumber":"minim commodo do aute","websiteUrl":"Duis nostrud qui","address":"ut amet occaecat","zipCode":"c","city":"incididunt aliqua"},{"customFields":{"consequat_2ee":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dolore_1":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"consectetur_5":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"proident_42":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"attachments":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"tags":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"recipients":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"creator":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"assets":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"subsequentProcessors":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"dpaSignatureDate":"1954-08-19T19:45:24.283Z","nbReferences":58124175,"subsequentProcessorCountryCodes":"non ullamco","id":-27462540,"ref":"proident","displayName":"in ut","dateCreation":"1987-08-31T00:29:30.809Z","dateUpdate":"1996-09-02T02:22:03.650Z","logoUrl":"ut","actorType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"vendorType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"accessLevel":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"givenName":"est minim id pariatur labore","familyName":"exercitation est Ut sint","companyName":"ma","description":"do","countryCode":"in","readonly":false,"email":"adipisicing nisi cillum","phoneNumber":"cons","contactName":"ad nisi","contactPosition":"e","immatriculationNumber":"laboris magna","websiteUrl":"labore consequat ullam","address":"dolor sed","zipCode":"ut proi","city":"dolor aliqua reprehenderit"}],"total":-73864312,"size":-63985686,"page":24295373}