API Reference

Export the data processing activities in any format

Log in to see full request history
Path Params
string
required

Supported export formats. Max size will depend on format

string
required
Query Params
string
boolean
Defaults to false
boolean
Defaults to true
boolean
Defaults to false
boolean
Defaults to false
uuid
cols
array of strings
cols
Body Params
string
uuid | null

Filter by a specific data retention rule identifier

uuid | null

Filter by any attached actor (stakholders, recipients, customers)

array of uuids | null

Filter by a specific stakeholder identifier

stakeholderIds
array of int32s | null

Filter by a specific stakeholder identifier

userIds
uuid | null

Filter by a specific actor identifier

uuid | null

Filter by a specific data controller identifier

uuid | null

Filter by a specific security measure

int32 | null

Filter by organizational unit identifier

boolean | null

Archived state

array of strings | null

Filter by any legal basis present in data processing purposes

legalBasis
array of strings | null

Filter by any legal basis present in data processing purposes

controls
array of uuids | null

Filter by tag ids

tags
array of int32s | null

Filter by workflow step identifier

workflows
array of uuids | null

Filter by data field ids

fields
boolean

If true, it will only get record with sensitive data

array of strings | null

Filter by transfer countries

countries
array of strings | null

Filter by internal states

states
string
uuid | null
string | null

Full text search

array of uuids | null

Filter by a list of id

ids
string | null

Comma separated list of fields

int32
1 to 2147483647

Pagination index (1 based, page 1 = 1, page 2 = 2...)

int32
1 to 9999

Size of the result page (default: 20, max 500)

int32 | null

The number of items to skip (if not provided, it will use the default page and size prop)

string | null

The field to sort

boolean

True to sort ascending

string | null

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"}))}

Response
200

OK

Language
Credentials
Click Try It! to start a request and see the response here!