6d091bc86a33
Find Data Classes
Finds Data Classes based on the provided criteria.
By default, this endpoint returns a basic description of the Data Classes that does not include the details of the Classification Rules. To retrieve the extended view of the Data Classes that includes the Classification Rules, you can pass the view=extended parameter.
Query parameters
Correlation ID used to relate logs occurring in distinct system components.
Applies a filter based on the status of the Data Classes.
Possible values:
- ENABLED
- DISABLED
If multiple status parameters are provided, the Data Classes matching any status defined as parameter are taken into account (OR logic).
Filters the Data Classes based on whether or not they contain rules.
If containsRules=true is defined as parameter, only the Data Classes containing rules are returned. This can be useful to retrieve only the Data Classes that can be used for automated classification.
Filter based on the ruleType of Classification Rules defined inside the Data Class. Multiple ruleType parameters can be provided. In this case, the API returns the DataClasses containing rules matching any of the defined types (OR logic).
The following values are currently supported:
- REGULAR_EXPRESSION
- REGULAR_EXPRESSION_COLUMN_NAME
- DATA_TYPE
- LIST_OF_VALUES
- CODE_SET
- LIKE
- GREATER_THAN
- LESS_THAN
- EQUAL
- BETWEEN
The name of a Data Class.
The matching logic is case insensitive and supports partial matches.
E.g. A search for EMAIL matches Data Class name Email Address
E.g. A search for Security matches Data Class name Social-Security-Number
The description of a Data Class.
The matching logic is case insensitive and supports partial matches.
The ID of a Data Class Group.
The index of the first result to retrieve.
If not set (offset = 0), results will be retrieved starting from row 0.
This is the maximum number of results that may be returned. Fewer may be returned than the value of <code>limit</code>.
Do not depend on the number of results being fewer than the <code>limit</code> value to indicate that your query reached the end of the list of data, use the absence of <code>after</code> (see Cursors) instead. For example, if you set <code>limit</code> to 10 and 9 results are returned, there may be more data available.
If not set, the default limit (limit = <code>25</code>) will be used. The maximum value for this parameter is <code>500</code>.
The view of the Data Class to return.
Possible values are basic or extended (case insensitive). The basic view does not include the rules, whereas the extended view does.
Response
Data Classes successfully retrieved.