Data Class
Collibra REST API authentication using Basic Authentication.
Correlation ID used to relate logs occurring in distinct system components.
Applies a filter based on the status of the Data Classes.
Possible values:
ENABLEDDISABLED
If multiple status parameters are provided, the Data Classes matching any status defined
as parameter are taken into account (OR logic).
["ENABLED"]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.
trueFilter 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_EXPRESSIONREGULAR_EXPRESSION_COLUMN_NAMEDATA_TYPELIST_OF_VALUESCODE_SETLIKEGREATER_THANLESS_THANEQUALBETWEEN
LIST_OF_VALUESThe 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.
0The maximum number of results to retrieve.
If not set, the default limit (limit = 50) will be used. The maximum value for this parameter is
1000.
50The 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.
basicData Classes successfully retrieved.
The total number of results.
1Invalid request to find Data Classes.
The client is not authenticated.
The user lacks permissions.
An unexpected error occurred.
Collibra REST API authentication using Basic Authentication.
Correlation ID used to relate logs occurring in distinct system components.
Request to create a Data Class. Only the name property is mandatory when creating a new Data Class.
Name of the Data Class.
emailThe description of the Data Class. The maximum length of this field is set to 10,000 characters.
Email addressThe status of a Data Class.
This attribute allows a Data Class to be ENABLED or DISABLED.
An DISABLED Data Class will never be used as part of the classification process.
Possible values:
ENABLEDDISABLED
ENABLEDThe Data Class is considered only if the column name is a full or partial match with the value of this property.
It is not case sensitive and it is using a text match (not a regular expression).
Any match will make the Data Class considered.
[]Example: ["email","e-mail"]The Data Class can only be considered if the column technical data type is part of the values defined for this property.
Valid values are: string, double, int, boolean, date, and timestamp.
[]Example: ["string","double"]If the value is set to true, null values are considered when calculating the confidence level of a matching Data Class.
If the value is set to false, only the non-null values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
falseIf the value is set to true, empty values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
If the value is set to false, only the non-empty values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
falseThe Data Class is only considered in the result if this confidence threshold is reached.
0Examples of values that match the Data Class.
[]Example: ["john.doe@acme.com","marc@company.com"]Data Class successfully created.
Invalid request to create a Data Class.
The client is not authenticated.
The user lacks permissions.
An unexpected error occurred.
Collibra REST API authentication using Basic Authentication.
Correlation ID used to relate logs occurring in distinct system components.
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.
basicIDs of the Data Classes contained in the Data Class Group.
Data Classes successfully retrieved.
The list of results.
The ID of the Data Class.
Name of the Data Class.
emailThe description of the Data Class. The maximum length of this field is set to 10,000 characters.
Email addressThe status of a Data Class.
This attribute allows a Data Class to be ENABLED or DISABLED.
An DISABLED Data Class will never be used as part of the classification process.
Possible values:
ENABLEDDISABLED
ENABLEDThe Data Class is considered only if the column name is a full or partial match with the value of this property.
It is not case sensitive and it is using a text match (not a regular expression).
Any match will make the Data Class considered.
[]Example: ["email","e-mail"]The Data Class can only be considered if the column technical data type is part of the values defined for this property.
Valid values are: string, double, int, boolean, date, and timestamp.
[]Example: ["string","double"]If the value is set to true, null values are considered when calculating the confidence level of a matching Data Class.
If the value is set to false, only the non-null values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
falseIf the value is set to true, empty values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
If the value is set to false, only the non-empty values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
falseThe Data Class is only considered in the result if this confidence threshold is reached.
0Examples of values that match the Data Class.
[]Example: ["john.doe@acme.com","marc@company.com"]The id of the user that created this resource.
4d250cc5-e583-4640-9874-b93d82c7a6cbThe timestamp (in UTC time standard) of the creation of this resource.
1475503010320The id of the user who modified this resource the last time.
a073ff90-e7bc-4b35-ba90-c4d475f642feThe timestamp (in UTC time standard) of the last modification of this resource.
1476703764163Invalid request to find Data Classes.
The client is not authenticated.
The user lacks permissions.
An unexpected error occurred.
Collibra REST API authentication using Basic Authentication.
The ID of a Data Class.
Correlation ID used to relate logs occurring in distinct system components.
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.
basicData Class successfully retrieved.
The ID of the Data Class.
Name of the Data Class.
emailThe description of the Data Class. The maximum length of this field is set to 10,000 characters.
Email addressThe status of a Data Class.
This attribute allows a Data Class to be ENABLED or DISABLED.
An DISABLED Data Class will never be used as part of the classification process.
Possible values:
ENABLEDDISABLED
ENABLEDThe Data Class is considered only if the column name is a full or partial match with the value of this property.
It is not case sensitive and it is using a text match (not a regular expression).
Any match will make the Data Class considered.
[]Example: ["email","e-mail"]The Data Class can only be considered if the column technical data type is part of the values defined for this property.
Valid values are: string, double, int, boolean, date, and timestamp.
[]Example: ["string","double"]If the value is set to true, null values are considered when calculating the confidence level of a matching Data Class.
If the value is set to false, only the non-null values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
falseIf the value is set to true, empty values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
If the value is set to false, only the non-empty values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
falseThe Data Class is only considered in the result if this confidence threshold is reached.
0Examples of values that match the Data Class.
[]Example: ["john.doe@acme.com","marc@company.com"]The id of the user that created this resource.
4d250cc5-e583-4640-9874-b93d82c7a6cbThe timestamp (in UTC time standard) of the creation of this resource.
1475503010320The id of the user who modified this resource the last time.
a073ff90-e7bc-4b35-ba90-c4d475f642feThe timestamp (in UTC time standard) of the last modification of this resource.
1476703764163The request is not valid.
The client is not authenticated.
The user lacks permissions.
Resource not found.
An unexpected error occurred.
Collibra REST API authentication using Basic Authentication.
The ID of a Data Class.
Correlation ID used to relate logs occurring in distinct system components.
Data Class successfully deleted.
No content
The request is not valid.
The client is not authenticated.
The user lacks permissions.
Resource not found.
No content
Collibra REST API authentication using Basic Authentication.
The ID of a Data Class.
Correlation ID used to relate logs occurring in distinct system components.
Request to change a Data Class.
All the attributes are optional.
Name of the Data Class.
emailThe description of the Data Class. The maximum length of this field is set to 10,000 characters.
Email addressThe status of a Data Class.
This attribute allows a Data Class to be ENABLED or DISABLED.
An DISABLED Data Class will never be used as part of the classification process.
Possible values:
ENABLEDDISABLED
ENABLEDThe Data Class is considered only if the column name is a full or partial match with the value of this property.
It is not case sensitive and it is using a text match (not a regular expression).
Any match will make the Data Class considered.
[]Example: ["email","e-mail"]The Data Class can only be considered if the column technical data type is part of the values defined for this property.
Valid values are: string, double, int, boolean, date, and timestamp.
[]Example: ["string","double"]If the value is set to true, null values are considered when calculating the confidence level of a matching Data Class.
If the value is set to false, only the non-null values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
falseIf the value is set to true, empty values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
If the value is set to false, only the non-empty values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
falseThe Data Class is only considered in the result if this confidence threshold is reached.
0Examples of values that match the Data Class.
[]Example: ["john.doe@acme.com","marc@company.com"]Data Class successfully changed.
The ID of the Data Class.
Name of the Data Class.
emailThe description of the Data Class. The maximum length of this field is set to 10,000 characters.
Email addressThe status of a Data Class.
This attribute allows a Data Class to be ENABLED or DISABLED.
An DISABLED Data Class will never be used as part of the classification process.
Possible values:
ENABLEDDISABLED
ENABLEDThe Data Class is considered only if the column name is a full or partial match with the value of this property.
It is not case sensitive and it is using a text match (not a regular expression).
Any match will make the Data Class considered.
[]Example: ["email","e-mail"]The Data Class can only be considered if the column technical data type is part of the values defined for this property.
Valid values are: string, double, int, boolean, date, and timestamp.
[]Example: ["string","double"]If the value is set to true, null values are considered when calculating the confidence level of a matching Data Class.
If the value is set to false, only the non-null values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
falseIf the value is set to true, empty values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
If the value is set to false, only the non-empty values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
falseThe Data Class is only considered in the result if this confidence threshold is reached.
0Examples of values that match the Data Class.
[]Example: ["john.doe@acme.com","marc@company.com"]The id of the user that created this resource.
4d250cc5-e583-4640-9874-b93d82c7a6cbThe timestamp (in UTC time standard) of the creation of this resource.
1475503010320The id of the user who modified this resource the last time.
a073ff90-e7bc-4b35-ba90-c4d475f642feThe timestamp (in UTC time standard) of the last modification of this resource.
1476703764163Invalid request to update a Data Class.
The client is not authenticated.
The user lacks permissions.
Resource not found.
An unexpected error occurred.
Collibra REST API authentication using Basic Authentication.
Request to merge Data Classes with a specific Data Class.
The name of a Data Class. Following the merge operation, only this specific Data Class will remain. If it doesn't exist, a new data class will be created.
The IDs of the Data Classes to be merged. At the end of the merge operation, those Data Classes will be deleted.
Data Classes have been merged successfully. The resulting Data Class is included in the response.
The ID of the Data Class.
Name of the Data Class.
emailThe description of the Data Class. The maximum length of this field is set to 10,000 characters.
Email addressThe status of a Data Class.
This attribute allows a Data Class to be ENABLED or DISABLED.
An DISABLED Data Class will never be used as part of the classification process.
Possible values:
ENABLEDDISABLED
ENABLEDThe Data Class is considered only if the column name is a full or partial match with the value of this property.
It is not case sensitive and it is using a text match (not a regular expression).
Any match will make the Data Class considered.
[]Example: ["email","e-mail"]The Data Class can only be considered if the column technical data type is part of the values defined for this property.
Valid values are: string, double, int, boolean, date, and timestamp.
[]Example: ["string","double"]If the value is set to true, null values are considered when calculating the confidence level of a matching Data Class.
If the value is set to false, only the non-null values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
falseIf the value is set to true, empty values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
If the value is set to false, only the non-empty values are considered by the classification process and are taken into account when calculating the confidence level of a matching Data Class.
falseThe Data Class is only considered in the result if this confidence threshold is reached.
0Examples of values that match the Data Class.
[]Example: ["john.doe@acme.com","marc@company.com"]The id of the user that created this resource.
4d250cc5-e583-4640-9874-b93d82c7a6cbThe timestamp (in UTC time standard) of the creation of this resource.
1475503010320The id of the user who modified this resource the last time.
a073ff90-e7bc-4b35-ba90-c4d475f642feThe timestamp (in UTC time standard) of the last modification of this resource.
1476703764163The request is not valid.
The client is not authenticated.
The user lacks permissions.
An unexpected error occurred.
Last updated
Was this helpful?