> For the complete documentation index, see [llms.txt](https://developer.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.collibra.com/api/references/data-class-management/models.md). # Models ## The ListOfValues object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ListOfValues":{"type":"object","properties":{"valueCount":{"$ref":"#/components/schemas/ValueCount"},"firstValues":{"$ref":"#/components/schemas/FirstValues"}}},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0},"FirstValues":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. Contains the first 1,000 values.\n"}}}} ``` ## The CodeSet object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"CodeSet":{"type":"object","description":"Represents a `Code Set` asset.\n","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/CodeSetId"},"valueCount":{"$ref":"#/components/schemas/ValueCount"}}},"CodeSetId":{"type":"string","format":"uuid","description":"The ID of a `Code Set` asset defined.\n"},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0}}}} ``` ## The DataClass object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"DataClass":{"type":"object","required":["id","name","status","allowNullValues","allowEmptyValues","confidenceThreshold","createdBy","createdOn","lastModifiedBy","lastModifiedOn"],"properties":{"id":{"$ref":"#/components/schemas/DataClassId"},"name":{"$ref":"#/components/schemas/DataClassName"},"description":{"$ref":"#/components/schemas/DataClassDescription"},"status":{"$ref":"#/components/schemas/DataClassStatus"},"columnNameFilters":{"$ref":"#/components/schemas/ColumnNameFilters"},"columnTypeFilters":{"$ref":"#/components/schemas/ColumnTypeFilters"},"allowNullValues":{"$ref":"#/components/schemas/AllowNullValues"},"allowEmptyValues":{"$ref":"#/components/schemas/AllowEmptyValues"},"confidenceThreshold":{"$ref":"#/components/schemas/ConfidenceThreshold"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdOn":{"$ref":"#/components/schemas/CreatedOn"},"lastModifiedBy":{"$ref":"#/components/schemas/LastModifiedBy"},"lastModifiedOn":{"$ref":"#/components/schemas/LastModifiedOn"},"rules":{"$ref":"#/components/schemas/ClassificationRules"}}},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"DataClassName":{"type":"string","description":"Name of the `Data Class`.\n"},"DataClassDescription":{"type":"string","description":"The description of the `Data Class`. The maximum length of this field is set to 10,000 characters.\n"},"DataClassStatus":{"type":"string","description":"The status of a `Data Class`.\n\nThis attribute allows a `Data Class` to be `ENABLED` or `DISABLED`.\nAn `DISABLED` `Data Class` will never be used as part of the classification process.\n\nPossible values:\n- `ENABLED`\n- `DISABLED`\n"},"ColumnNameFilters":{"type":"array","items":{"type":"string"},"default":[],"description":"The `Data Class` is considered only if the column name is a full or partial match with the value of this property.\n\nIt is not case sensitive and it is using a text match (not a regular expression).\n\nAny match will make the `Data Class` considered.\n"},"ColumnTypeFilters":{"type":"array","items":{"type":"string"},"default":[],"description":"The `Data Class` can only be considered if the column technical data type is part of the values defined for this property.\n\nValid values are: `string`, `double`, `int`, `boolean`, `date`, and `timestamp`.\n"},"AllowNullValues":{"type":"boolean","description":"If the value is set to `true`, null values are considered when calculating the confidence level of a matching `Data Class`.\n\nIf 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`.\n","default":false},"AllowEmptyValues":{"type":"boolean","description":"If 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`.\n\nIf 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`.\n","default":false},"ConfidenceThreshold":{"type":"integer","description":"The Data Class is only considered in the result if this confidence threshold is reached.","default":0,"minimum":0,"maximum":100},"CreatedBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"CreatedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"LastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"LastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"ClassificationRules":{"type":"array","description":"`Classification Rules` defined for the `Data Class`.\n","items":{"$ref":"#/components/schemas/ClassificationRuleWithId"}},"ClassificationRuleWithId":{"description":"A `ClassificationRule` defines a read-only representation of a rule.\n","oneOf":[{"$ref":"#/components/schemas/SingleValuedClassificationRuleWithId"},{"$ref":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/DataTypeBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/ListOfValuesBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/BetweenClassificationRuleWithId"},{"$ref":"#/components/schemas/CodeSetBasedClassificationRuleWithId"}],"discriminator":{"propertyName":"type","mapping":{"REGULAR_EXPRESSION":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId","REGULAR_EXPRESSION_COLUMN_NAME":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId","DATA_TYPE":"#/components/schemas/DataTypeBasedClassificationRuleWithId","LIST_OF_VALUES":"#/components/schemas/ListOfValuesBasedClassificationRuleWithId","CODE_SET":"#/components/schemas/CodeSetBasedClassificationRuleWithId","LIKE":"#/components/schemas/SingleValuedClassificationRuleWithId","GREATER_THAN":"#/components/schemas/SingleValuedClassificationRuleWithId","LESS_THAN":"#/components/schemas/SingleValuedClassificationRuleWithId","EQUAL":"#/components/schemas/SingleValuedClassificationRuleWithId","BETWEEN":"#/components/schemas/BetweenClassificationRuleWithId"}}},"SingleValuedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/SingleValuedClassificationRule"}]},"BaseClassificationRuleWithId":{"type":"object","required":["id","createdBy","createdOn","lastModifiedBy","lastModifiedOn"],"properties":{"id":{"$ref":"#/components/schemas/ClassificationRuleId"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdOn":{"$ref":"#/components/schemas/CreatedOn"},"lastModifiedBy":{"$ref":"#/components/schemas/LastModifiedBy"},"lastModifiedOn":{"$ref":"#/components/schemas/LastModifiedOn"}}},"ClassificationRuleId":{"type":"string","format":"uuid","description":"The ID of a `Classification Rule`.\n"},"SingleValuedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseSingleValuedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseSingleValuedClassificationRule":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/Value"}}},"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"},"RegularExpressionBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/RegularExpressionBasedClassificationRule"}]},"RegularExpressionBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseRegularExpressionBasedClassificationRule"}]},"BaseRegularExpressionBasedClassificationRule":{"type":"object","properties":{"regularExpression":{"$ref":"#/components/schemas/RegularExpression"}}},"RegularExpression":{"type":"string","description":"A regular expression. The maximum length of this field is set to 10,000 characters.\n"},"DataTypeBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/DataTypeBasedClassificationRule"}]},"DataTypeBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseDataTypeBasedClassificationRule"}]},"BaseDataTypeBasedClassificationRule":{"type":"object","properties":{"dataTypes":{"type":"array","description":"The list of data types defining this rule.","items":{"$ref":"#/components/schemas/DataType"}}}},"DataType":{"type":"string","description":"A data type.\n"},"ListOfValuesBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/ListOfValuesBasedClassificationRule"}]},"ListOfValuesBasedClassificationRule":{"description":"`Classification Rule` based on a `List Of Values`.\n","allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseListOfValuesBasedClassificationRule"}]},"BaseListOfValuesBasedClassificationRule":{"type":"object","properties":{"listOfValues":{"$ref":"#/components/schemas/ListOfValues"}}},"ListOfValues":{"type":"object","properties":{"valueCount":{"$ref":"#/components/schemas/ValueCount"},"firstValues":{"$ref":"#/components/schemas/FirstValues"}}},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0},"FirstValues":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. Contains the first 1,000 values.\n"},"BetweenClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/BetweenClassificationRule"}]},"BetweenClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseBetweenClassificationRule"}]},"BaseBetweenClassificationRule":{"type":"object","properties":{"minValueInclusive":{"$ref":"#/components/schemas/Value"},"maxValueInclusive":{"$ref":"#/components/schemas/Value"}}},"CodeSetBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/CodeSetBasedClassificationRule"}]},"CodeSetBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseCodeSetBasedClassificationRule"}]},"BaseCodeSetBasedClassificationRule":{"type":"object","properties":{"codeSet":{"$ref":"#/components/schemas/CodeSet"}}},"CodeSet":{"type":"object","description":"Represents a `Code Set` asset.\n","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/CodeSetId"},"valueCount":{"$ref":"#/components/schemas/ValueCount"}}},"CodeSetId":{"type":"string","format":"uuid","description":"The ID of a `Code Set` asset defined.\n"}}}} ``` ## The DataClassGroup object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"DataClassGroup":{"type":"object","description":"Group of `Data Classes`.\n","required":["id","name","dataClasses"],"properties":{"id":{"$ref":"#/components/schemas/DataClassGroupId"},"name":{"$ref":"#/components/schemas/DataClassGroupName"},"dataClasses":{"$ref":"#/components/schemas/DataClassIds"}}},"DataClassGroupId":{"type":"string","format":"uuid","description":"The ID of the `Data Class Group`.\n"},"DataClassGroupName":{"type":"string","description":"Name of the `Data Class Group`.\n"},"DataClassIds":{"type":"array","description":"IDs of the `Data Classes` contained in the `Data Class Group`.\n","items":{"$ref":"#/components/schemas/DataClassId"}},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"}}}} ``` ## The AddDataClassRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"AddDataClassRequest":{"type":"object","description":"Request to create a `Data Class`. Only the `name` property is mandatory when creating a new `Data Class`.\n","required":["name"],"properties":{"name":{"$ref":"#/components/schemas/DataClassName"},"description":{"$ref":"#/components/schemas/DataClassDescription"},"status":{"$ref":"#/components/schemas/DataClassStatus"},"columnNameFilters":{"$ref":"#/components/schemas/ColumnNameFilters"},"columnTypeFilters":{"$ref":"#/components/schemas/ColumnTypeFilters"},"allowNullValues":{"$ref":"#/components/schemas/AllowNullValues"},"allowEmptyValues":{"$ref":"#/components/schemas/AllowEmptyValues"},"confidenceThreshold":{"$ref":"#/components/schemas/ConfidenceThreshold"}}},"DataClassName":{"type":"string","description":"Name of the `Data Class`.\n"},"DataClassDescription":{"type":"string","description":"The description of the `Data Class`. The maximum length of this field is set to 10,000 characters.\n"},"DataClassStatus":{"type":"string","description":"The status of a `Data Class`.\n\nThis attribute allows a `Data Class` to be `ENABLED` or `DISABLED`.\nAn `DISABLED` `Data Class` will never be used as part of the classification process.\n\nPossible values:\n- `ENABLED`\n- `DISABLED`\n"},"ColumnNameFilters":{"type":"array","items":{"type":"string"},"default":[],"description":"The `Data Class` is considered only if the column name is a full or partial match with the value of this property.\n\nIt is not case sensitive and it is using a text match (not a regular expression).\n\nAny match will make the `Data Class` considered.\n"},"ColumnTypeFilters":{"type":"array","items":{"type":"string"},"default":[],"description":"The `Data Class` can only be considered if the column technical data type is part of the values defined for this property.\n\nValid values are: `string`, `double`, `int`, `boolean`, `date`, and `timestamp`.\n"},"AllowNullValues":{"type":"boolean","description":"If the value is set to `true`, null values are considered when calculating the confidence level of a matching `Data Class`.\n\nIf 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`.\n","default":false},"AllowEmptyValues":{"type":"boolean","description":"If 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`.\n\nIf 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`.\n","default":false},"ConfidenceThreshold":{"type":"integer","description":"The Data Class is only considered in the result if this confidence threshold is reached.","default":0,"minimum":0,"maximum":100}}}} ``` ## The ChangeDataClassRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ChangeDataClassRequest":{"type":"object","description":"Request to change a `Data Class`.\n\nAll the attributes are optional.\n","properties":{"name":{"$ref":"#/components/schemas/DataClassName"},"description":{"$ref":"#/components/schemas/DataClassDescription"},"status":{"$ref":"#/components/schemas/DataClassStatus"},"columnNameFilters":{"$ref":"#/components/schemas/ColumnNameFilters"},"columnTypeFilters":{"$ref":"#/components/schemas/ColumnTypeFilters"},"allowNullValues":{"$ref":"#/components/schemas/AllowNullValues"},"allowEmptyValues":{"$ref":"#/components/schemas/AllowEmptyValues"},"confidenceThreshold":{"$ref":"#/components/schemas/ConfidenceThreshold"}}},"DataClassName":{"type":"string","description":"Name of the `Data Class`.\n"},"DataClassDescription":{"type":"string","description":"The description of the `Data Class`. The maximum length of this field is set to 10,000 characters.\n"},"DataClassStatus":{"type":"string","description":"The status of a `Data Class`.\n\nThis attribute allows a `Data Class` to be `ENABLED` or `DISABLED`.\nAn `DISABLED` `Data Class` will never be used as part of the classification process.\n\nPossible values:\n- `ENABLED`\n- `DISABLED`\n"},"ColumnNameFilters":{"type":"array","items":{"type":"string"},"default":[],"description":"The `Data Class` is considered only if the column name is a full or partial match with the value of this property.\n\nIt is not case sensitive and it is using a text match (not a regular expression).\n\nAny match will make the `Data Class` considered.\n"},"ColumnTypeFilters":{"type":"array","items":{"type":"string"},"default":[],"description":"The `Data Class` can only be considered if the column technical data type is part of the values defined for this property.\n\nValid values are: `string`, `double`, `int`, `boolean`, `date`, and `timestamp`.\n"},"AllowNullValues":{"type":"boolean","description":"If the value is set to `true`, null values are considered when calculating the confidence level of a matching `Data Class`.\n\nIf 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`.\n","default":false},"AllowEmptyValues":{"type":"boolean","description":"If 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`.\n\nIf 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`.\n","default":false},"ConfidenceThreshold":{"type":"integer","description":"The Data Class is only considered in the result if this confidence threshold is reached.","default":0,"minimum":0,"maximum":100}}}} ``` ## The ChangeClassificationRuleRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ChangeClassificationRuleRequest":{"type":"object","description":"Request to change a `Classification Rule`.\n","oneOf":[{"$ref":"#/components/schemas/ChangeSingleValuedClassificationRuleRequest"},{"$ref":"#/components/schemas/ChangeRegularExpressionBasedClassificationRuleRequest"},{"$ref":"#/components/schemas/ChangeDataTypeBasedClassificationRuleRequest"},{"$ref":"#/components/schemas/ChangeInlineListOfValuesBasedClassificationRuleRequest"},{"$ref":"#/components/schemas/ChangeInlineCsvListOfValuesBasedClassificationRuleRequest"},{"$ref":"#/components/schemas/ChangeBetweenClassificationRuleRequest"},{"$ref":"#/components/schemas/ChangeCodeSetBasedClassificationRuleRequest"}],"discriminator":{"propertyName":"type","mapping":{"REGULAR_EXPRESSION":"#/components/schemas/ChangeRegularExpressionBasedClassificationRuleRequest","REGULAR_EXPRESSION_COLUMN_NAME":"#/components/schemas/ChangeRegularExpressionBasedClassificationRuleRequest","DATA_TYPE":"#/components/schemas/ChangeDataTypeBasedClassificationRuleRequest","LIST_OF_VALUES_INLINE_ARRAY":"#/components/schemas/ChangeInlineListOfValuesBasedClassificationRuleRequest","LIST_OF_VALUES_INLINE_CSV":"#/components/schemas/ChangeInlineCsvListOfValuesBasedClassificationRuleRequest","CODE_SET":"#/components/schemas/ChangeCodeSetBasedClassificationRuleRequest","LIKE":"#/components/schemas/ChangeSingleValuedClassificationRuleRequest","GREATER_THAN":"#/components/schemas/ChangeSingleValuedClassificationRuleRequest","LESS_THAN":"#/components/schemas/ChangeSingleValuedClassificationRuleRequest","EQUAL":"#/components/schemas/ChangeSingleValuedClassificationRuleRequest","BETWEEN":"#/components/schemas/ChangeBetweenClassificationRuleRequest"}}},"ChangeSingleValuedClassificationRuleRequest":{"allOf":[{"$ref":"#/components/schemas/BaseChangeClassificationRuleRequest"},{"$ref":"#/components/schemas/BaseSingleValuedClassificationRule"}]},"BaseChangeClassificationRuleRequest":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseSingleValuedClassificationRule":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/Value"}}},"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"},"ChangeRegularExpressionBasedClassificationRuleRequest":{"allOf":[{"$ref":"#/components/schemas/BaseChangeClassificationRuleRequest"},{"$ref":"#/components/schemas/BaseRegularExpressionBasedClassificationRule"}]},"BaseRegularExpressionBasedClassificationRule":{"type":"object","properties":{"regularExpression":{"$ref":"#/components/schemas/RegularExpression"}}},"RegularExpression":{"type":"string","description":"A regular expression. The maximum length of this field is set to 10,000 characters.\n"},"ChangeDataTypeBasedClassificationRuleRequest":{"allOf":[{"$ref":"#/components/schemas/BaseChangeClassificationRuleRequest"},{"$ref":"#/components/schemas/BaseDataTypeBasedClassificationRule"}]},"BaseDataTypeBasedClassificationRule":{"type":"object","properties":{"dataTypes":{"type":"array","description":"The list of data types defining this rule.","items":{"$ref":"#/components/schemas/DataType"}}}},"DataType":{"type":"string","description":"A data type.\n"},"ChangeInlineListOfValuesBasedClassificationRuleRequest":{"description":"`Classification Rule` based on a `List Of Values` defined inline as an array of values.\n","allOf":[{"$ref":"#/components/schemas/BaseChangeClassificationRuleRequest"},{"$ref":"#/components/schemas/BaseInlineListOfValuesBasedClassificationRule"}]},"BaseInlineListOfValuesBasedClassificationRule":{"type":"object","properties":{"values":{"$ref":"#/components/schemas/Values"}}},"Values":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. \n\nThis array has a maximum size of 1,000 values.\nTo provide more than 1,000 values, provide them via file instead.\n"},"ChangeInlineCsvListOfValuesBasedClassificationRuleRequest":{"type":"object","description":"`Classification Rule` based on a `List Of Values` defined as a single value in CSV format.\n","allOf":[{"$ref":"#/components/schemas/BaseChangeClassificationRuleRequest"},{"$ref":"#/components/schemas/BaseInlineCsvListOfValuesBasedClassificationRule"}]},"BaseInlineCsvListOfValuesBasedClassificationRule":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/ValuesAsCsv"}}},"ValuesAsCsv":{"type":"string","description":"Values defined as a CSV-formatted string in which each value is defined one a separate line.\n\nThe following characters are supported as valid value separators:\n- Carriage return (aka `CR` or `\\r`) \n- Line feed (aka `LF` or `\\n`)\n- The end of line sequence composed of those 2 characters (aka `EOL` or `\\r\\n`)\n"},"ChangeBetweenClassificationRuleRequest":{"allOf":[{"$ref":"#/components/schemas/BaseChangeClassificationRuleRequest"},{"$ref":"#/components/schemas/BaseBetweenClassificationRule"}]},"BaseBetweenClassificationRule":{"type":"object","properties":{"minValueInclusive":{"$ref":"#/components/schemas/Value"},"maxValueInclusive":{"$ref":"#/components/schemas/Value"}}},"ChangeCodeSetBasedClassificationRuleRequest":{"allOf":[{"$ref":"#/components/schemas/BaseChangeClassificationRuleRequest"},{"$ref":"#/components/schemas/BaseCodeSetBasedClassificationRule"}]},"BaseCodeSetBasedClassificationRule":{"type":"object","properties":{"codeSet":{"$ref":"#/components/schemas/CodeSet"}}},"CodeSet":{"type":"object","description":"Represents a `Code Set` asset.\n","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/CodeSetId"},"valueCount":{"$ref":"#/components/schemas/ValueCount"}}},"CodeSetId":{"type":"string","format":"uuid","description":"The ID of a `Code Set` asset defined.\n"},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0}}}} ``` ## The ChangeClassificationRuleWithFileRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ChangeClassificationRuleWithFileRequest":{"type":"object","description":"Request to change a `Classification Rule` with file.\n","oneOf":[{"$ref":"#/components/schemas/ChangeListOfValuesWithFileBasedClassificationRuleRequest"}],"discriminator":{"propertyName":"type","mapping":{"LIST_OF_VALUES":"#/components/schemas/ChangeListOfValuesWithFileBasedClassificationRuleRequest"}}},"ChangeListOfValuesWithFileBasedClassificationRuleRequest":{"description":"`Classification Rule` based on a `List Of Values` defined as a file with values.\n","type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/FileRuleType"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"FileRuleType":{"type":"string","description":"RuleType used in case of creating or updating rule with file.\n\nThe following values are currently supported:\n - `LIST_OF_VALUES`\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"}}}} ``` ## The MergeDataClassesRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"MergeDataClassesRequest":{"type":"object","description":"Request to merge `Data Classes` with a specific `Data Class`.\n","required":["targetDataClass","dataClassesToBeMerged"],"properties":{"targetDataClass":{"$ref":"#/components/schemas/TargetDataClassName"},"dataClassesToBeMerged":{"$ref":"#/components/schemas/ToBeMergedDataClassIds"}}},"TargetDataClassName":{"type":"string","description":"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.\n"},"ToBeMergedDataClassIds":{"type":"array","description":"The IDs of the `Data Classes` to be merged. At the end of the merge operation, those `Data Classes` will be deleted.\n","items":{"$ref":"#/components/schemas/DataClassId"},"minItems":1},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"}}}} ``` ## The ChangeDataClassGroupRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ChangeDataClassGroupRequest":{"type":"object","description":"Request to update a `Data Class Group`.\n\nAll the attributes are optional.\n","properties":{"name":{"$ref":"#/components/schemas/DataClassGroupName"},"dataClasses":{"$ref":"#/components/schemas/DataClassIds"}}},"DataClassGroupName":{"type":"string","description":"Name of the `Data Class Group`.\n"},"DataClassIds":{"type":"array","description":"IDs of the `Data Classes` contained in the `Data Class Group`.\n","items":{"$ref":"#/components/schemas/DataClassId"}},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"}}}} ``` ## The AddDataClassGroupRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"AddDataClassGroupRequest":{"type":"object","description":"Request to create a `Data Class Group`.\n\nOnly the `name` property is mandatory. If no data classes are defined, the group is created empty.\n","required":["name"],"properties":{"name":{"$ref":"#/components/schemas/DataClassGroupName"},"dataClasses":{"$ref":"#/components/schemas/DataClassIds"}}},"DataClassGroupName":{"type":"string","description":"Name of the `Data Class Group`.\n"},"DataClassIds":{"type":"array","description":"IDs of the `Data Classes` contained in the `Data Class Group`.\n","items":{"$ref":"#/components/schemas/DataClassId"}},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"}}}} ``` ## The AddClassificationRuleRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"AddClassificationRuleRequest":{"description":"Request to create a `Classification Rule` under an existing `Data Class`. \n\nOnly the `type` and `dataClassId` properties are mandatory when creating a new `Classification Rule`.\n","oneOf":[{"$ref":"#/components/schemas/SingleValuedClassificationRule"},{"$ref":"#/components/schemas/RegularExpressionBasedClassificationRule"},{"$ref":"#/components/schemas/DataTypeBasedClassificationRule"},{"$ref":"#/components/schemas/InlineListOfValuesBasedClassificationRule"},{"$ref":"#/components/schemas/InlineCsvListOfValuesBasedClassificationRule"},{"$ref":"#/components/schemas/BetweenClassificationRule"},{"$ref":"#/components/schemas/CodeSetBasedClassificationRule"}],"discriminator":{"propertyName":"type","mapping":{"REGULAR_EXPRESSION":"#/components/schemas/RegularExpressionBasedClassificationRule","REGULAR_EXPRESSION_COLUMN_NAME":"#/components/schemas/RegularExpressionBasedClassificationRule","DATA_TYPE":"#/components/schemas/DataTypeBasedClassificationRule","LIST_OF_VALUES_INLINE_ARRAY":"#/components/schemas/InlineListOfValuesBasedClassificationRule","LIST_OF_VALUES_INLINE_CSV":"#/components/schemas/InlineCsvListOfValuesBasedClassificationRule","CODE_SET":"#/components/schemas/CodeSetBasedClassificationRule","LIKE":"#/components/schemas/SingleValuedClassificationRule","GREATER_THAN":"#/components/schemas/SingleValuedClassificationRule","LESS_THAN":"#/components/schemas/SingleValuedClassificationRule","EQUAL":"#/components/schemas/SingleValuedClassificationRule","BETWEEN":"#/components/schemas/BetweenClassificationRule"}}},"SingleValuedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseSingleValuedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseSingleValuedClassificationRule":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/Value"}}},"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"},"RegularExpressionBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseRegularExpressionBasedClassificationRule"}]},"BaseRegularExpressionBasedClassificationRule":{"type":"object","properties":{"regularExpression":{"$ref":"#/components/schemas/RegularExpression"}}},"RegularExpression":{"type":"string","description":"A regular expression. The maximum length of this field is set to 10,000 characters.\n"},"DataTypeBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseDataTypeBasedClassificationRule"}]},"BaseDataTypeBasedClassificationRule":{"type":"object","properties":{"dataTypes":{"type":"array","description":"The list of data types defining this rule.","items":{"$ref":"#/components/schemas/DataType"}}}},"DataType":{"type":"string","description":"A data type.\n"},"InlineListOfValuesBasedClassificationRule":{"description":"`Classification Rule` based on a `List Of Values` defined inline as an array of values.\n","allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseInlineListOfValuesBasedClassificationRule"}]},"BaseInlineListOfValuesBasedClassificationRule":{"type":"object","properties":{"values":{"$ref":"#/components/schemas/Values"}}},"Values":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. \n\nThis array has a maximum size of 1,000 values.\nTo provide more than 1,000 values, provide them via file instead.\n"},"InlineCsvListOfValuesBasedClassificationRule":{"type":"object","description":"`Classification Rule` based on a `List Of Values` defined as a single value in CSV format.\n","allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseInlineCsvListOfValuesBasedClassificationRule"}]},"BaseInlineCsvListOfValuesBasedClassificationRule":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/ValuesAsCsv"}}},"ValuesAsCsv":{"type":"string","description":"Values defined as a CSV-formatted string in which each value is defined one a separate line.\n\nThe following characters are supported as valid value separators:\n- Carriage return (aka `CR` or `\\r`) \n- Line feed (aka `LF` or `\\n`)\n- The end of line sequence composed of those 2 characters (aka `EOL` or `\\r\\n`)\n"},"BetweenClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseBetweenClassificationRule"}]},"BaseBetweenClassificationRule":{"type":"object","properties":{"minValueInclusive":{"$ref":"#/components/schemas/Value"},"maxValueInclusive":{"$ref":"#/components/schemas/Value"}}},"CodeSetBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseCodeSetBasedClassificationRule"}]},"BaseCodeSetBasedClassificationRule":{"type":"object","properties":{"codeSet":{"$ref":"#/components/schemas/CodeSet"}}},"CodeSet":{"type":"object","description":"Represents a `Code Set` asset.\n","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/CodeSetId"},"valueCount":{"$ref":"#/components/schemas/ValueCount"}}},"CodeSetId":{"type":"string","format":"uuid","description":"The ID of a `Code Set` asset defined.\n"},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0}}}} ``` ## The AddClassificationRuleWithFileRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"AddClassificationRuleWithFileRequest":{"type":"object","description":"Request to create a `Classification Rule` under an existing `Data Class` with file. \n\nOnly the `type` and `dataClassId` properties are mandatory when creating a new `Classification Rule`.\n","oneOf":[{"$ref":"#/components/schemas/ListOfValuesWithFileBasedClassificationRule"}],"discriminator":{"propertyName":"type","mapping":{"LIST_OF_VALUES":"#/components/schemas/ListOfValuesWithFileBasedClassificationRule"}}},"ListOfValuesWithFileBasedClassificationRule":{"description":"`Classification Rule` based on a `List Of Values` defined as a file with values.\n","type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/FileRuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"FileRuleType":{"type":"string","description":"RuleType used in case of creating or updating rule with file.\n\nThe following values are currently supported:\n - `LIST_OF_VALUES`\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"}}}} ``` ## The BaseClassificationRuleWithId object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"BaseClassificationRuleWithId":{"type":"object","required":["id","createdBy","createdOn","lastModifiedBy","lastModifiedOn"],"properties":{"id":{"$ref":"#/components/schemas/ClassificationRuleId"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdOn":{"$ref":"#/components/schemas/CreatedOn"},"lastModifiedBy":{"$ref":"#/components/schemas/LastModifiedBy"},"lastModifiedOn":{"$ref":"#/components/schemas/LastModifiedOn"}}},"ClassificationRuleId":{"type":"string","format":"uuid","description":"The ID of a `Classification Rule`.\n"},"CreatedBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"CreatedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"LastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"LastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"}}}} ``` ## The BaseClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"}}}} ``` ## The BaseChangeClassificationRuleRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"BaseChangeClassificationRuleRequest":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"}}}} ``` ## The ClassificationRuleWithId object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ClassificationRuleWithId":{"description":"A `ClassificationRule` defines a read-only representation of a rule.\n","oneOf":[{"$ref":"#/components/schemas/SingleValuedClassificationRuleWithId"},{"$ref":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/DataTypeBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/ListOfValuesBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/BetweenClassificationRuleWithId"},{"$ref":"#/components/schemas/CodeSetBasedClassificationRuleWithId"}],"discriminator":{"propertyName":"type","mapping":{"REGULAR_EXPRESSION":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId","REGULAR_EXPRESSION_COLUMN_NAME":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId","DATA_TYPE":"#/components/schemas/DataTypeBasedClassificationRuleWithId","LIST_OF_VALUES":"#/components/schemas/ListOfValuesBasedClassificationRuleWithId","CODE_SET":"#/components/schemas/CodeSetBasedClassificationRuleWithId","LIKE":"#/components/schemas/SingleValuedClassificationRuleWithId","GREATER_THAN":"#/components/schemas/SingleValuedClassificationRuleWithId","LESS_THAN":"#/components/schemas/SingleValuedClassificationRuleWithId","EQUAL":"#/components/schemas/SingleValuedClassificationRuleWithId","BETWEEN":"#/components/schemas/BetweenClassificationRuleWithId"}}},"SingleValuedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/SingleValuedClassificationRule"}]},"BaseClassificationRuleWithId":{"type":"object","required":["id","createdBy","createdOn","lastModifiedBy","lastModifiedOn"],"properties":{"id":{"$ref":"#/components/schemas/ClassificationRuleId"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdOn":{"$ref":"#/components/schemas/CreatedOn"},"lastModifiedBy":{"$ref":"#/components/schemas/LastModifiedBy"},"lastModifiedOn":{"$ref":"#/components/schemas/LastModifiedOn"}}},"ClassificationRuleId":{"type":"string","format":"uuid","description":"The ID of a `Classification Rule`.\n"},"CreatedBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"CreatedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"LastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"LastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"SingleValuedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseSingleValuedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseSingleValuedClassificationRule":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/Value"}}},"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"},"RegularExpressionBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/RegularExpressionBasedClassificationRule"}]},"RegularExpressionBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseRegularExpressionBasedClassificationRule"}]},"BaseRegularExpressionBasedClassificationRule":{"type":"object","properties":{"regularExpression":{"$ref":"#/components/schemas/RegularExpression"}}},"RegularExpression":{"type":"string","description":"A regular expression. The maximum length of this field is set to 10,000 characters.\n"},"DataTypeBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/DataTypeBasedClassificationRule"}]},"DataTypeBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseDataTypeBasedClassificationRule"}]},"BaseDataTypeBasedClassificationRule":{"type":"object","properties":{"dataTypes":{"type":"array","description":"The list of data types defining this rule.","items":{"$ref":"#/components/schemas/DataType"}}}},"DataType":{"type":"string","description":"A data type.\n"},"ListOfValuesBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/ListOfValuesBasedClassificationRule"}]},"ListOfValuesBasedClassificationRule":{"description":"`Classification Rule` based on a `List Of Values`.\n","allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseListOfValuesBasedClassificationRule"}]},"BaseListOfValuesBasedClassificationRule":{"type":"object","properties":{"listOfValues":{"$ref":"#/components/schemas/ListOfValues"}}},"ListOfValues":{"type":"object","properties":{"valueCount":{"$ref":"#/components/schemas/ValueCount"},"firstValues":{"$ref":"#/components/schemas/FirstValues"}}},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0},"FirstValues":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. Contains the first 1,000 values.\n"},"BetweenClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/BetweenClassificationRule"}]},"BetweenClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseBetweenClassificationRule"}]},"BaseBetweenClassificationRule":{"type":"object","properties":{"minValueInclusive":{"$ref":"#/components/schemas/Value"},"maxValueInclusive":{"$ref":"#/components/schemas/Value"}}},"CodeSetBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/CodeSetBasedClassificationRule"}]},"CodeSetBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseCodeSetBasedClassificationRule"}]},"BaseCodeSetBasedClassificationRule":{"type":"object","properties":{"codeSet":{"$ref":"#/components/schemas/CodeSet"}}},"CodeSet":{"type":"object","description":"Represents a `Code Set` asset.\n","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/CodeSetId"},"valueCount":{"$ref":"#/components/schemas/ValueCount"}}},"CodeSetId":{"type":"string","format":"uuid","description":"The ID of a `Code Set` asset defined.\n"}}}} ``` ## The BaseSingleValuedClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"BaseSingleValuedClassificationRule":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/Value"}}},"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"}}}} ``` ## The SingleValuedClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"SingleValuedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseSingleValuedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseSingleValuedClassificationRule":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/Value"}}},"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"}}}} ``` ## The ChangeSingleValuedClassificationRuleRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ChangeSingleValuedClassificationRuleRequest":{"allOf":[{"$ref":"#/components/schemas/BaseChangeClassificationRuleRequest"},{"$ref":"#/components/schemas/BaseSingleValuedClassificationRule"}]},"BaseChangeClassificationRuleRequest":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseSingleValuedClassificationRule":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/Value"}}},"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"}}}} ``` ## The SingleValuedClassificationRuleWithId object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"SingleValuedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/SingleValuedClassificationRule"}]},"BaseClassificationRuleWithId":{"type":"object","required":["id","createdBy","createdOn","lastModifiedBy","lastModifiedOn"],"properties":{"id":{"$ref":"#/components/schemas/ClassificationRuleId"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdOn":{"$ref":"#/components/schemas/CreatedOn"},"lastModifiedBy":{"$ref":"#/components/schemas/LastModifiedBy"},"lastModifiedOn":{"$ref":"#/components/schemas/LastModifiedOn"}}},"ClassificationRuleId":{"type":"string","format":"uuid","description":"The ID of a `Classification Rule`.\n"},"CreatedBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"CreatedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"LastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"LastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"SingleValuedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseSingleValuedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseSingleValuedClassificationRule":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/Value"}}},"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"}}}} ``` ## The BaseRegularExpressionBasedClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"BaseRegularExpressionBasedClassificationRule":{"type":"object","properties":{"regularExpression":{"$ref":"#/components/schemas/RegularExpression"}}},"RegularExpression":{"type":"string","description":"A regular expression. The maximum length of this field is set to 10,000 characters.\n"}}}} ``` ## The RegularExpressionBasedClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"RegularExpressionBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseRegularExpressionBasedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseRegularExpressionBasedClassificationRule":{"type":"object","properties":{"regularExpression":{"$ref":"#/components/schemas/RegularExpression"}}},"RegularExpression":{"type":"string","description":"A regular expression. The maximum length of this field is set to 10,000 characters.\n"}}}} ``` ## The ChangeRegularExpressionBasedClassificationRuleRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ChangeRegularExpressionBasedClassificationRuleRequest":{"allOf":[{"$ref":"#/components/schemas/BaseChangeClassificationRuleRequest"},{"$ref":"#/components/schemas/BaseRegularExpressionBasedClassificationRule"}]},"BaseChangeClassificationRuleRequest":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseRegularExpressionBasedClassificationRule":{"type":"object","properties":{"regularExpression":{"$ref":"#/components/schemas/RegularExpression"}}},"RegularExpression":{"type":"string","description":"A regular expression. The maximum length of this field is set to 10,000 characters.\n"}}}} ``` ## The RegularExpressionBasedClassificationRuleWithId object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"RegularExpressionBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/RegularExpressionBasedClassificationRule"}]},"BaseClassificationRuleWithId":{"type":"object","required":["id","createdBy","createdOn","lastModifiedBy","lastModifiedOn"],"properties":{"id":{"$ref":"#/components/schemas/ClassificationRuleId"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdOn":{"$ref":"#/components/schemas/CreatedOn"},"lastModifiedBy":{"$ref":"#/components/schemas/LastModifiedBy"},"lastModifiedOn":{"$ref":"#/components/schemas/LastModifiedOn"}}},"ClassificationRuleId":{"type":"string","format":"uuid","description":"The ID of a `Classification Rule`.\n"},"CreatedBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"CreatedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"LastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"LastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"RegularExpressionBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseRegularExpressionBasedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseRegularExpressionBasedClassificationRule":{"type":"object","properties":{"regularExpression":{"$ref":"#/components/schemas/RegularExpression"}}},"RegularExpression":{"type":"string","description":"A regular expression. The maximum length of this field is set to 10,000 characters.\n"}}}} ``` ## The BaseDataTypeBasedClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"BaseDataTypeBasedClassificationRule":{"type":"object","properties":{"dataTypes":{"type":"array","description":"The list of data types defining this rule.","items":{"$ref":"#/components/schemas/DataType"}}}},"DataType":{"type":"string","description":"A data type.\n"}}}} ``` ## The DataTypeBasedClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"DataTypeBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseDataTypeBasedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseDataTypeBasedClassificationRule":{"type":"object","properties":{"dataTypes":{"type":"array","description":"The list of data types defining this rule.","items":{"$ref":"#/components/schemas/DataType"}}}},"DataType":{"type":"string","description":"A data type.\n"}}}} ``` ## The ChangeDataTypeBasedClassificationRuleRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ChangeDataTypeBasedClassificationRuleRequest":{"allOf":[{"$ref":"#/components/schemas/BaseChangeClassificationRuleRequest"},{"$ref":"#/components/schemas/BaseDataTypeBasedClassificationRule"}]},"BaseChangeClassificationRuleRequest":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseDataTypeBasedClassificationRule":{"type":"object","properties":{"dataTypes":{"type":"array","description":"The list of data types defining this rule.","items":{"$ref":"#/components/schemas/DataType"}}}},"DataType":{"type":"string","description":"A data type.\n"}}}} ``` ## The DataTypeBasedClassificationRuleWithId object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"DataTypeBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/DataTypeBasedClassificationRule"}]},"BaseClassificationRuleWithId":{"type":"object","required":["id","createdBy","createdOn","lastModifiedBy","lastModifiedOn"],"properties":{"id":{"$ref":"#/components/schemas/ClassificationRuleId"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdOn":{"$ref":"#/components/schemas/CreatedOn"},"lastModifiedBy":{"$ref":"#/components/schemas/LastModifiedBy"},"lastModifiedOn":{"$ref":"#/components/schemas/LastModifiedOn"}}},"ClassificationRuleId":{"type":"string","format":"uuid","description":"The ID of a `Classification Rule`.\n"},"CreatedBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"CreatedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"LastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"LastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"DataTypeBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseDataTypeBasedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseDataTypeBasedClassificationRule":{"type":"object","properties":{"dataTypes":{"type":"array","description":"The list of data types defining this rule.","items":{"$ref":"#/components/schemas/DataType"}}}},"DataType":{"type":"string","description":"A data type.\n"}}}} ``` ## The BaseInlineListOfValuesBasedClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"BaseInlineListOfValuesBasedClassificationRule":{"type":"object","properties":{"values":{"$ref":"#/components/schemas/Values"}}},"Values":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. \n\nThis array has a maximum size of 1,000 values.\nTo provide more than 1,000 values, provide them via file instead.\n"}}}} ``` ## The InlineListOfValuesBasedClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"InlineListOfValuesBasedClassificationRule":{"description":"`Classification Rule` based on a `List Of Values` defined inline as an array of values.\n","allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseInlineListOfValuesBasedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseInlineListOfValuesBasedClassificationRule":{"type":"object","properties":{"values":{"$ref":"#/components/schemas/Values"}}},"Values":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. \n\nThis array has a maximum size of 1,000 values.\nTo provide more than 1,000 values, provide them via file instead.\n"}}}} ``` ## The ListOfValuesWithFileBasedClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ListOfValuesWithFileBasedClassificationRule":{"description":"`Classification Rule` based on a `List Of Values` defined as a file with values.\n","type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/FileRuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"FileRuleType":{"type":"string","description":"RuleType used in case of creating or updating rule with file.\n\nThe following values are currently supported:\n - `LIST_OF_VALUES`\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"}}}} ``` ## The ChangeListOfValuesWithFileBasedClassificationRuleRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ChangeListOfValuesWithFileBasedClassificationRuleRequest":{"description":"`Classification Rule` based on a `List Of Values` defined as a file with values.\n","type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/FileRuleType"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"FileRuleType":{"type":"string","description":"RuleType used in case of creating or updating rule with file.\n\nThe following values are currently supported:\n - `LIST_OF_VALUES`\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"}}}} ``` ## The ChangeInlineListOfValuesBasedClassificationRuleRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ChangeInlineListOfValuesBasedClassificationRuleRequest":{"description":"`Classification Rule` based on a `List Of Values` defined inline as an array of values.\n","allOf":[{"$ref":"#/components/schemas/BaseChangeClassificationRuleRequest"},{"$ref":"#/components/schemas/BaseInlineListOfValuesBasedClassificationRule"}]},"BaseChangeClassificationRuleRequest":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseInlineListOfValuesBasedClassificationRule":{"type":"object","properties":{"values":{"$ref":"#/components/schemas/Values"}}},"Values":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. \n\nThis array has a maximum size of 1,000 values.\nTo provide more than 1,000 values, provide them via file instead.\n"}}}} ``` ## The BaseInlineCsvListOfValuesBasedClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"BaseInlineCsvListOfValuesBasedClassificationRule":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/ValuesAsCsv"}}},"ValuesAsCsv":{"type":"string","description":"Values defined as a CSV-formatted string in which each value is defined one a separate line.\n\nThe following characters are supported as valid value separators:\n- Carriage return (aka `CR` or `\\r`) \n- Line feed (aka `LF` or `\\n`)\n- The end of line sequence composed of those 2 characters (aka `EOL` or `\\r\\n`)\n"}}}} ``` ## The InlineCsvListOfValuesBasedClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"InlineCsvListOfValuesBasedClassificationRule":{"type":"object","description":"`Classification Rule` based on a `List Of Values` defined as a single value in CSV format.\n","allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseInlineCsvListOfValuesBasedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseInlineCsvListOfValuesBasedClassificationRule":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/ValuesAsCsv"}}},"ValuesAsCsv":{"type":"string","description":"Values defined as a CSV-formatted string in which each value is defined one a separate line.\n\nThe following characters are supported as valid value separators:\n- Carriage return (aka `CR` or `\\r`) \n- Line feed (aka `LF` or `\\n`)\n- The end of line sequence composed of those 2 characters (aka `EOL` or `\\r\\n`)\n"}}}} ``` ## The ChangeInlineCsvListOfValuesBasedClassificationRuleRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ChangeInlineCsvListOfValuesBasedClassificationRuleRequest":{"type":"object","description":"`Classification Rule` based on a `List Of Values` defined as a single value in CSV format.\n","allOf":[{"$ref":"#/components/schemas/BaseChangeClassificationRuleRequest"},{"$ref":"#/components/schemas/BaseInlineCsvListOfValuesBasedClassificationRule"}]},"BaseChangeClassificationRuleRequest":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseInlineCsvListOfValuesBasedClassificationRule":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/ValuesAsCsv"}}},"ValuesAsCsv":{"type":"string","description":"Values defined as a CSV-formatted string in which each value is defined one a separate line.\n\nThe following characters are supported as valid value separators:\n- Carriage return (aka `CR` or `\\r`) \n- Line feed (aka `LF` or `\\n`)\n- The end of line sequence composed of those 2 characters (aka `EOL` or `\\r\\n`)\n"}}}} ``` ## The BaseBetweenClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"BaseBetweenClassificationRule":{"type":"object","properties":{"minValueInclusive":{"$ref":"#/components/schemas/Value"},"maxValueInclusive":{"$ref":"#/components/schemas/Value"}}},"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"}}}} ``` ## The BetweenClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"BetweenClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseBetweenClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseBetweenClassificationRule":{"type":"object","properties":{"minValueInclusive":{"$ref":"#/components/schemas/Value"},"maxValueInclusive":{"$ref":"#/components/schemas/Value"}}},"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"}}}} ``` ## The ChangeBetweenClassificationRuleRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ChangeBetweenClassificationRuleRequest":{"allOf":[{"$ref":"#/components/schemas/BaseChangeClassificationRuleRequest"},{"$ref":"#/components/schemas/BaseBetweenClassificationRule"}]},"BaseChangeClassificationRuleRequest":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseBetweenClassificationRule":{"type":"object","properties":{"minValueInclusive":{"$ref":"#/components/schemas/Value"},"maxValueInclusive":{"$ref":"#/components/schemas/Value"}}},"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"}}}} ``` ## The BetweenClassificationRuleWithId object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"BetweenClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/BetweenClassificationRule"}]},"BaseClassificationRuleWithId":{"type":"object","required":["id","createdBy","createdOn","lastModifiedBy","lastModifiedOn"],"properties":{"id":{"$ref":"#/components/schemas/ClassificationRuleId"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdOn":{"$ref":"#/components/schemas/CreatedOn"},"lastModifiedBy":{"$ref":"#/components/schemas/LastModifiedBy"},"lastModifiedOn":{"$ref":"#/components/schemas/LastModifiedOn"}}},"ClassificationRuleId":{"type":"string","format":"uuid","description":"The ID of a `Classification Rule`.\n"},"CreatedBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"CreatedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"LastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"LastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"BetweenClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseBetweenClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseBetweenClassificationRule":{"type":"object","properties":{"minValueInclusive":{"$ref":"#/components/schemas/Value"},"maxValueInclusive":{"$ref":"#/components/schemas/Value"}}},"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"}}}} ``` ## The BaseListOfValuesBasedClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"BaseListOfValuesBasedClassificationRule":{"type":"object","properties":{"listOfValues":{"$ref":"#/components/schemas/ListOfValues"}}},"ListOfValues":{"type":"object","properties":{"valueCount":{"$ref":"#/components/schemas/ValueCount"},"firstValues":{"$ref":"#/components/schemas/FirstValues"}}},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0},"FirstValues":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. Contains the first 1,000 values.\n"}}}} ``` ## The ListOfValuesBasedClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ListOfValuesBasedClassificationRule":{"description":"`Classification Rule` based on a `List Of Values`.\n","allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseListOfValuesBasedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseListOfValuesBasedClassificationRule":{"type":"object","properties":{"listOfValues":{"$ref":"#/components/schemas/ListOfValues"}}},"ListOfValues":{"type":"object","properties":{"valueCount":{"$ref":"#/components/schemas/ValueCount"},"firstValues":{"$ref":"#/components/schemas/FirstValues"}}},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0},"FirstValues":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. Contains the first 1,000 values.\n"}}}} ``` ## The ChangeListOfValuesBasedClassificationRuleRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ChangeListOfValuesBasedClassificationRuleRequest":{"description":"`Classification Rule` based on a `List Of Values`.\n","allOf":[{"$ref":"#/components/schemas/BaseChangeClassificationRuleRequest"},{"$ref":"#/components/schemas/BaseListOfValuesBasedClassificationRule"}]},"BaseChangeClassificationRuleRequest":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseListOfValuesBasedClassificationRule":{"type":"object","properties":{"listOfValues":{"$ref":"#/components/schemas/ListOfValues"}}},"ListOfValues":{"type":"object","properties":{"valueCount":{"$ref":"#/components/schemas/ValueCount"},"firstValues":{"$ref":"#/components/schemas/FirstValues"}}},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0},"FirstValues":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. Contains the first 1,000 values.\n"}}}} ``` ## The ListOfValuesBasedClassificationRuleWithId object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ListOfValuesBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/ListOfValuesBasedClassificationRule"}]},"BaseClassificationRuleWithId":{"type":"object","required":["id","createdBy","createdOn","lastModifiedBy","lastModifiedOn"],"properties":{"id":{"$ref":"#/components/schemas/ClassificationRuleId"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdOn":{"$ref":"#/components/schemas/CreatedOn"},"lastModifiedBy":{"$ref":"#/components/schemas/LastModifiedBy"},"lastModifiedOn":{"$ref":"#/components/schemas/LastModifiedOn"}}},"ClassificationRuleId":{"type":"string","format":"uuid","description":"The ID of a `Classification Rule`.\n"},"CreatedBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"CreatedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"LastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"LastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"ListOfValuesBasedClassificationRule":{"description":"`Classification Rule` based on a `List Of Values`.\n","allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseListOfValuesBasedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseListOfValuesBasedClassificationRule":{"type":"object","properties":{"listOfValues":{"$ref":"#/components/schemas/ListOfValues"}}},"ListOfValues":{"type":"object","properties":{"valueCount":{"$ref":"#/components/schemas/ValueCount"},"firstValues":{"$ref":"#/components/schemas/FirstValues"}}},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0},"FirstValues":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. Contains the first 1,000 values.\n"}}}} ``` ## The BaseCodeSetBasedClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"BaseCodeSetBasedClassificationRule":{"type":"object","properties":{"codeSet":{"$ref":"#/components/schemas/CodeSet"}}},"CodeSet":{"type":"object","description":"Represents a `Code Set` asset.\n","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/CodeSetId"},"valueCount":{"$ref":"#/components/schemas/ValueCount"}}},"CodeSetId":{"type":"string","format":"uuid","description":"The ID of a `Code Set` asset defined.\n"},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0}}}} ``` ## The CodeSetBasedClassificationRule object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"CodeSetBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseCodeSetBasedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseCodeSetBasedClassificationRule":{"type":"object","properties":{"codeSet":{"$ref":"#/components/schemas/CodeSet"}}},"CodeSet":{"type":"object","description":"Represents a `Code Set` asset.\n","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/CodeSetId"},"valueCount":{"$ref":"#/components/schemas/ValueCount"}}},"CodeSetId":{"type":"string","format":"uuid","description":"The ID of a `Code Set` asset defined.\n"},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0}}}} ``` ## The ChangeCodeSetBasedClassificationRuleRequest object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ChangeCodeSetBasedClassificationRuleRequest":{"allOf":[{"$ref":"#/components/schemas/BaseChangeClassificationRuleRequest"},{"$ref":"#/components/schemas/BaseCodeSetBasedClassificationRule"}]},"BaseChangeClassificationRuleRequest":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseCodeSetBasedClassificationRule":{"type":"object","properties":{"codeSet":{"$ref":"#/components/schemas/CodeSet"}}},"CodeSet":{"type":"object","description":"Represents a `Code Set` asset.\n","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/CodeSetId"},"valueCount":{"$ref":"#/components/schemas/ValueCount"}}},"CodeSetId":{"type":"string","format":"uuid","description":"The ID of a `Code Set` asset defined.\n"},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0}}}} ``` ## The CodeSetBasedClassificationRuleWithId object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"CodeSetBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/CodeSetBasedClassificationRule"}]},"BaseClassificationRuleWithId":{"type":"object","required":["id","createdBy","createdOn","lastModifiedBy","lastModifiedOn"],"properties":{"id":{"$ref":"#/components/schemas/ClassificationRuleId"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdOn":{"$ref":"#/components/schemas/CreatedOn"},"lastModifiedBy":{"$ref":"#/components/schemas/LastModifiedBy"},"lastModifiedOn":{"$ref":"#/components/schemas/LastModifiedOn"}}},"ClassificationRuleId":{"type":"string","format":"uuid","description":"The ID of a `Classification Rule`.\n"},"CreatedBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"CreatedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"LastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"LastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"CodeSetBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseCodeSetBasedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseCodeSetBasedClassificationRule":{"type":"object","properties":{"codeSet":{"$ref":"#/components/schemas/CodeSet"}}},"CodeSet":{"type":"object","description":"Represents a `Code Set` asset.\n","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/CodeSetId"},"valueCount":{"$ref":"#/components/schemas/ValueCount"}}},"CodeSetId":{"type":"string","format":"uuid","description":"The ID of a `Code Set` asset defined.\n"},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0}}}} ``` ## The ValuePagedResponse object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ValuePagedResponse":{"type":"object","properties":{"nextCursor":{"type":"string","description":"An opaque cursor that can be used to query the next page of results."},"results":{"type":"array","description":"The list of results.","items":{"$ref":"#/components/schemas/Value"}}}},"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"}}}} ``` ## The DataClassPagedResponse object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"DataClassPagedResponse":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of results."},"results":{"type":"array","description":"The list of results.","items":{"$ref":"#/components/schemas/DataClass"}}}},"DataClass":{"type":"object","required":["id","name","status","allowNullValues","allowEmptyValues","confidenceThreshold","createdBy","createdOn","lastModifiedBy","lastModifiedOn"],"properties":{"id":{"$ref":"#/components/schemas/DataClassId"},"name":{"$ref":"#/components/schemas/DataClassName"},"description":{"$ref":"#/components/schemas/DataClassDescription"},"status":{"$ref":"#/components/schemas/DataClassStatus"},"columnNameFilters":{"$ref":"#/components/schemas/ColumnNameFilters"},"columnTypeFilters":{"$ref":"#/components/schemas/ColumnTypeFilters"},"allowNullValues":{"$ref":"#/components/schemas/AllowNullValues"},"allowEmptyValues":{"$ref":"#/components/schemas/AllowEmptyValues"},"confidenceThreshold":{"$ref":"#/components/schemas/ConfidenceThreshold"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdOn":{"$ref":"#/components/schemas/CreatedOn"},"lastModifiedBy":{"$ref":"#/components/schemas/LastModifiedBy"},"lastModifiedOn":{"$ref":"#/components/schemas/LastModifiedOn"},"rules":{"$ref":"#/components/schemas/ClassificationRules"}}},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"DataClassName":{"type":"string","description":"Name of the `Data Class`.\n"},"DataClassDescription":{"type":"string","description":"The description of the `Data Class`. The maximum length of this field is set to 10,000 characters.\n"},"DataClassStatus":{"type":"string","description":"The status of a `Data Class`.\n\nThis attribute allows a `Data Class` to be `ENABLED` or `DISABLED`.\nAn `DISABLED` `Data Class` will never be used as part of the classification process.\n\nPossible values:\n- `ENABLED`\n- `DISABLED`\n"},"ColumnNameFilters":{"type":"array","items":{"type":"string"},"default":[],"description":"The `Data Class` is considered only if the column name is a full or partial match with the value of this property.\n\nIt is not case sensitive and it is using a text match (not a regular expression).\n\nAny match will make the `Data Class` considered.\n"},"ColumnTypeFilters":{"type":"array","items":{"type":"string"},"default":[],"description":"The `Data Class` can only be considered if the column technical data type is part of the values defined for this property.\n\nValid values are: `string`, `double`, `int`, `boolean`, `date`, and `timestamp`.\n"},"AllowNullValues":{"type":"boolean","description":"If the value is set to `true`, null values are considered when calculating the confidence level of a matching `Data Class`.\n\nIf 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`.\n","default":false},"AllowEmptyValues":{"type":"boolean","description":"If 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`.\n\nIf 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`.\n","default":false},"ConfidenceThreshold":{"type":"integer","description":"The Data Class is only considered in the result if this confidence threshold is reached.","default":0,"minimum":0,"maximum":100},"CreatedBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"CreatedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"LastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"LastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"ClassificationRules":{"type":"array","description":"`Classification Rules` defined for the `Data Class`.\n","items":{"$ref":"#/components/schemas/ClassificationRuleWithId"}},"ClassificationRuleWithId":{"description":"A `ClassificationRule` defines a read-only representation of a rule.\n","oneOf":[{"$ref":"#/components/schemas/SingleValuedClassificationRuleWithId"},{"$ref":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/DataTypeBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/ListOfValuesBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/BetweenClassificationRuleWithId"},{"$ref":"#/components/schemas/CodeSetBasedClassificationRuleWithId"}],"discriminator":{"propertyName":"type","mapping":{"REGULAR_EXPRESSION":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId","REGULAR_EXPRESSION_COLUMN_NAME":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId","DATA_TYPE":"#/components/schemas/DataTypeBasedClassificationRuleWithId","LIST_OF_VALUES":"#/components/schemas/ListOfValuesBasedClassificationRuleWithId","CODE_SET":"#/components/schemas/CodeSetBasedClassificationRuleWithId","LIKE":"#/components/schemas/SingleValuedClassificationRuleWithId","GREATER_THAN":"#/components/schemas/SingleValuedClassificationRuleWithId","LESS_THAN":"#/components/schemas/SingleValuedClassificationRuleWithId","EQUAL":"#/components/schemas/SingleValuedClassificationRuleWithId","BETWEEN":"#/components/schemas/BetweenClassificationRuleWithId"}}},"SingleValuedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/SingleValuedClassificationRule"}]},"BaseClassificationRuleWithId":{"type":"object","required":["id","createdBy","createdOn","lastModifiedBy","lastModifiedOn"],"properties":{"id":{"$ref":"#/components/schemas/ClassificationRuleId"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdOn":{"$ref":"#/components/schemas/CreatedOn"},"lastModifiedBy":{"$ref":"#/components/schemas/LastModifiedBy"},"lastModifiedOn":{"$ref":"#/components/schemas/LastModifiedOn"}}},"ClassificationRuleId":{"type":"string","format":"uuid","description":"The ID of a `Classification Rule`.\n"},"SingleValuedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseSingleValuedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseSingleValuedClassificationRule":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/Value"}}},"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"},"RegularExpressionBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/RegularExpressionBasedClassificationRule"}]},"RegularExpressionBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseRegularExpressionBasedClassificationRule"}]},"BaseRegularExpressionBasedClassificationRule":{"type":"object","properties":{"regularExpression":{"$ref":"#/components/schemas/RegularExpression"}}},"RegularExpression":{"type":"string","description":"A regular expression. The maximum length of this field is set to 10,000 characters.\n"},"DataTypeBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/DataTypeBasedClassificationRule"}]},"DataTypeBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseDataTypeBasedClassificationRule"}]},"BaseDataTypeBasedClassificationRule":{"type":"object","properties":{"dataTypes":{"type":"array","description":"The list of data types defining this rule.","items":{"$ref":"#/components/schemas/DataType"}}}},"DataType":{"type":"string","description":"A data type.\n"},"ListOfValuesBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/ListOfValuesBasedClassificationRule"}]},"ListOfValuesBasedClassificationRule":{"description":"`Classification Rule` based on a `List Of Values`.\n","allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseListOfValuesBasedClassificationRule"}]},"BaseListOfValuesBasedClassificationRule":{"type":"object","properties":{"listOfValues":{"$ref":"#/components/schemas/ListOfValues"}}},"ListOfValues":{"type":"object","properties":{"valueCount":{"$ref":"#/components/schemas/ValueCount"},"firstValues":{"$ref":"#/components/schemas/FirstValues"}}},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0},"FirstValues":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. Contains the first 1,000 values.\n"},"BetweenClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/BetweenClassificationRule"}]},"BetweenClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseBetweenClassificationRule"}]},"BaseBetweenClassificationRule":{"type":"object","properties":{"minValueInclusive":{"$ref":"#/components/schemas/Value"},"maxValueInclusive":{"$ref":"#/components/schemas/Value"}}},"CodeSetBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/CodeSetBasedClassificationRule"}]},"CodeSetBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseCodeSetBasedClassificationRule"}]},"BaseCodeSetBasedClassificationRule":{"type":"object","properties":{"codeSet":{"$ref":"#/components/schemas/CodeSet"}}},"CodeSet":{"type":"object","description":"Represents a `Code Set` asset.\n","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/CodeSetId"},"valueCount":{"$ref":"#/components/schemas/ValueCount"}}},"CodeSetId":{"type":"string","format":"uuid","description":"The ID of a `Code Set` asset defined.\n"}}}} ``` ## The ClassificationRulePagedResponse object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ClassificationRulePagedResponse":{"type":"object","properties":{"results":{"type":"array","description":"The list of results.","items":{"$ref":"#/components/schemas/ClassificationRuleWithId"}}}},"ClassificationRuleWithId":{"description":"A `ClassificationRule` defines a read-only representation of a rule.\n","oneOf":[{"$ref":"#/components/schemas/SingleValuedClassificationRuleWithId"},{"$ref":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/DataTypeBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/ListOfValuesBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/BetweenClassificationRuleWithId"},{"$ref":"#/components/schemas/CodeSetBasedClassificationRuleWithId"}],"discriminator":{"propertyName":"type","mapping":{"REGULAR_EXPRESSION":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId","REGULAR_EXPRESSION_COLUMN_NAME":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId","DATA_TYPE":"#/components/schemas/DataTypeBasedClassificationRuleWithId","LIST_OF_VALUES":"#/components/schemas/ListOfValuesBasedClassificationRuleWithId","CODE_SET":"#/components/schemas/CodeSetBasedClassificationRuleWithId","LIKE":"#/components/schemas/SingleValuedClassificationRuleWithId","GREATER_THAN":"#/components/schemas/SingleValuedClassificationRuleWithId","LESS_THAN":"#/components/schemas/SingleValuedClassificationRuleWithId","EQUAL":"#/components/schemas/SingleValuedClassificationRuleWithId","BETWEEN":"#/components/schemas/BetweenClassificationRuleWithId"}}},"SingleValuedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/SingleValuedClassificationRule"}]},"BaseClassificationRuleWithId":{"type":"object","required":["id","createdBy","createdOn","lastModifiedBy","lastModifiedOn"],"properties":{"id":{"$ref":"#/components/schemas/ClassificationRuleId"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdOn":{"$ref":"#/components/schemas/CreatedOn"},"lastModifiedBy":{"$ref":"#/components/schemas/LastModifiedBy"},"lastModifiedOn":{"$ref":"#/components/schemas/LastModifiedOn"}}},"ClassificationRuleId":{"type":"string","format":"uuid","description":"The ID of a `Classification Rule`.\n"},"CreatedBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"CreatedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"LastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"LastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"SingleValuedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseSingleValuedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseSingleValuedClassificationRule":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/Value"}}},"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"},"RegularExpressionBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/RegularExpressionBasedClassificationRule"}]},"RegularExpressionBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseRegularExpressionBasedClassificationRule"}]},"BaseRegularExpressionBasedClassificationRule":{"type":"object","properties":{"regularExpression":{"$ref":"#/components/schemas/RegularExpression"}}},"RegularExpression":{"type":"string","description":"A regular expression. The maximum length of this field is set to 10,000 characters.\n"},"DataTypeBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/DataTypeBasedClassificationRule"}]},"DataTypeBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseDataTypeBasedClassificationRule"}]},"BaseDataTypeBasedClassificationRule":{"type":"object","properties":{"dataTypes":{"type":"array","description":"The list of data types defining this rule.","items":{"$ref":"#/components/schemas/DataType"}}}},"DataType":{"type":"string","description":"A data type.\n"},"ListOfValuesBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/ListOfValuesBasedClassificationRule"}]},"ListOfValuesBasedClassificationRule":{"description":"`Classification Rule` based on a `List Of Values`.\n","allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseListOfValuesBasedClassificationRule"}]},"BaseListOfValuesBasedClassificationRule":{"type":"object","properties":{"listOfValues":{"$ref":"#/components/schemas/ListOfValues"}}},"ListOfValues":{"type":"object","properties":{"valueCount":{"$ref":"#/components/schemas/ValueCount"},"firstValues":{"$ref":"#/components/schemas/FirstValues"}}},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0},"FirstValues":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. Contains the first 1,000 values.\n"},"BetweenClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/BetweenClassificationRule"}]},"BetweenClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseBetweenClassificationRule"}]},"BaseBetweenClassificationRule":{"type":"object","properties":{"minValueInclusive":{"$ref":"#/components/schemas/Value"},"maxValueInclusive":{"$ref":"#/components/schemas/Value"}}},"CodeSetBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/CodeSetBasedClassificationRule"}]},"CodeSetBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseCodeSetBasedClassificationRule"}]},"BaseCodeSetBasedClassificationRule":{"type":"object","properties":{"codeSet":{"$ref":"#/components/schemas/CodeSet"}}},"CodeSet":{"type":"object","description":"Represents a `Code Set` asset.\n","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/CodeSetId"},"valueCount":{"$ref":"#/components/schemas/ValueCount"}}},"CodeSetId":{"type":"string","format":"uuid","description":"The ID of a `Code Set` asset defined.\n"}}}} ``` ## The DataClassGroupPagedResponse object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"DataClassGroupPagedResponse":{"type":"object","properties":{"results":{"type":"array","description":"The list of results.","items":{"$ref":"#/components/schemas/DataClassGroup"}}}},"DataClassGroup":{"type":"object","description":"Group of `Data Classes`.\n","required":["id","name","dataClasses"],"properties":{"id":{"$ref":"#/components/schemas/DataClassGroupId"},"name":{"$ref":"#/components/schemas/DataClassGroupName"},"dataClasses":{"$ref":"#/components/schemas/DataClassIds"}}},"DataClassGroupId":{"type":"string","format":"uuid","description":"The ID of the `Data Class Group`.\n"},"DataClassGroupName":{"type":"string","description":"Name of the `Data Class Group`.\n"},"DataClassIds":{"type":"array","description":"IDs of the `Data Classes` contained in the `Data Class Group`.\n","items":{"$ref":"#/components/schemas/DataClassId"}},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"}}}} ``` ## The DataClassName object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"DataClassName":{"type":"string","description":"Name of the `Data Class`.\n"}}}} ``` ## The DataClassDescription object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"DataClassDescription":{"type":"string","description":"The description of the `Data Class`. The maximum length of this field is set to 10,000 characters.\n"}}}} ``` ## The DataClassStatus object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"DataClassStatus":{"type":"string","description":"The status of a `Data Class`.\n\nThis attribute allows a `Data Class` to be `ENABLED` or `DISABLED`.\nAn `DISABLED` `Data Class` will never be used as part of the classification process.\n\nPossible values:\n- `ENABLED`\n- `DISABLED`\n"}}}} ``` ## The CodeSetId object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"CodeSetId":{"type":"string","format":"uuid","description":"The ID of a `Code Set` asset defined.\n"}}}} ``` ## The DataClassId object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"}}}} ``` ## The ClassificationRuleId object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ClassificationRuleId":{"type":"string","format":"uuid","description":"The ID of a `Classification Rule`.\n"}}}} ``` ## The TargetDataClassName object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"TargetDataClassName":{"type":"string","description":"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.\n"}}}} ``` ## The DataClassIds object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"DataClassIds":{"type":"array","description":"IDs of the `Data Classes` contained in the `Data Class Group`.\n","items":{"$ref":"#/components/schemas/DataClassId"}},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"}}}} ``` ## The ToBeMergedDataClassIds object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ToBeMergedDataClassIds":{"type":"array","description":"The IDs of the `Data Classes` to be merged. At the end of the merge operation, those `Data Classes` will be deleted.\n","items":{"$ref":"#/components/schemas/DataClassId"},"minItems":1},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"}}}} ``` ## The ClassificationRules object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ClassificationRules":{"type":"array","description":"`Classification Rules` defined for the `Data Class`.\n","items":{"$ref":"#/components/schemas/ClassificationRuleWithId"}},"ClassificationRuleWithId":{"description":"A `ClassificationRule` defines a read-only representation of a rule.\n","oneOf":[{"$ref":"#/components/schemas/SingleValuedClassificationRuleWithId"},{"$ref":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/DataTypeBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/ListOfValuesBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/BetweenClassificationRuleWithId"},{"$ref":"#/components/schemas/CodeSetBasedClassificationRuleWithId"}],"discriminator":{"propertyName":"type","mapping":{"REGULAR_EXPRESSION":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId","REGULAR_EXPRESSION_COLUMN_NAME":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId","DATA_TYPE":"#/components/schemas/DataTypeBasedClassificationRuleWithId","LIST_OF_VALUES":"#/components/schemas/ListOfValuesBasedClassificationRuleWithId","CODE_SET":"#/components/schemas/CodeSetBasedClassificationRuleWithId","LIKE":"#/components/schemas/SingleValuedClassificationRuleWithId","GREATER_THAN":"#/components/schemas/SingleValuedClassificationRuleWithId","LESS_THAN":"#/components/schemas/SingleValuedClassificationRuleWithId","EQUAL":"#/components/schemas/SingleValuedClassificationRuleWithId","BETWEEN":"#/components/schemas/BetweenClassificationRuleWithId"}}},"SingleValuedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/SingleValuedClassificationRule"}]},"BaseClassificationRuleWithId":{"type":"object","required":["id","createdBy","createdOn","lastModifiedBy","lastModifiedOn"],"properties":{"id":{"$ref":"#/components/schemas/ClassificationRuleId"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdOn":{"$ref":"#/components/schemas/CreatedOn"},"lastModifiedBy":{"$ref":"#/components/schemas/LastModifiedBy"},"lastModifiedOn":{"$ref":"#/components/schemas/LastModifiedOn"}}},"ClassificationRuleId":{"type":"string","format":"uuid","description":"The ID of a `Classification Rule`.\n"},"CreatedBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"CreatedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"LastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"LastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"SingleValuedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseSingleValuedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseSingleValuedClassificationRule":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/Value"}}},"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"},"RegularExpressionBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/RegularExpressionBasedClassificationRule"}]},"RegularExpressionBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseRegularExpressionBasedClassificationRule"}]},"BaseRegularExpressionBasedClassificationRule":{"type":"object","properties":{"regularExpression":{"$ref":"#/components/schemas/RegularExpression"}}},"RegularExpression":{"type":"string","description":"A regular expression. The maximum length of this field is set to 10,000 characters.\n"},"DataTypeBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/DataTypeBasedClassificationRule"}]},"DataTypeBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseDataTypeBasedClassificationRule"}]},"BaseDataTypeBasedClassificationRule":{"type":"object","properties":{"dataTypes":{"type":"array","description":"The list of data types defining this rule.","items":{"$ref":"#/components/schemas/DataType"}}}},"DataType":{"type":"string","description":"A data type.\n"},"ListOfValuesBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/ListOfValuesBasedClassificationRule"}]},"ListOfValuesBasedClassificationRule":{"description":"`Classification Rule` based on a `List Of Values`.\n","allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseListOfValuesBasedClassificationRule"}]},"BaseListOfValuesBasedClassificationRule":{"type":"object","properties":{"listOfValues":{"$ref":"#/components/schemas/ListOfValues"}}},"ListOfValues":{"type":"object","properties":{"valueCount":{"$ref":"#/components/schemas/ValueCount"},"firstValues":{"$ref":"#/components/schemas/FirstValues"}}},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0},"FirstValues":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. Contains the first 1,000 values.\n"},"BetweenClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/BetweenClassificationRule"}]},"BetweenClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseBetweenClassificationRule"}]},"BaseBetweenClassificationRule":{"type":"object","properties":{"minValueInclusive":{"$ref":"#/components/schemas/Value"},"maxValueInclusive":{"$ref":"#/components/schemas/Value"}}},"CodeSetBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/CodeSetBasedClassificationRule"}]},"CodeSetBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseCodeSetBasedClassificationRule"}]},"BaseCodeSetBasedClassificationRule":{"type":"object","properties":{"codeSet":{"$ref":"#/components/schemas/CodeSet"}}},"CodeSet":{"type":"object","description":"Represents a `Code Set` asset.\n","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/CodeSetId"},"valueCount":{"$ref":"#/components/schemas/ValueCount"}}},"CodeSetId":{"type":"string","format":"uuid","description":"The ID of a `Code Set` asset defined.\n"}}}} ``` ## The RuleType object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"}}}} ``` ## The FileRuleType object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"FileRuleType":{"type":"string","description":"RuleType used in case of creating or updating rule with file.\n\nThe following values are currently supported:\n - `LIST_OF_VALUES`\n"}}}} ``` ## The RegularExpression object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"RegularExpression":{"type":"string","description":"A regular expression. The maximum length of this field is set to 10,000 characters.\n"}}}} ``` ## The DataType object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"DataType":{"type":"string","description":"A data type.\n"}}}} ``` ## The ClassificationRuleDescription object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"}}}} ``` ## The Value object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"}}}} ``` ## The Values object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"Values":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. \n\nThis array has a maximum size of 1,000 values.\nTo provide more than 1,000 values, provide them via file instead.\n"}}}} ``` ## The FirstValues object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"FirstValues":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. Contains the first 1,000 values.\n"}}}} ``` ## The ValuesAsCsv object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ValuesAsCsv":{"type":"string","description":"Values defined as a CSV-formatted string in which each value is defined one a separate line.\n\nThe following characters are supported as valid value separators:\n- Carriage return (aka `CR` or `\\r`) \n- Line feed (aka `LF` or `\\n`)\n- The end of line sequence composed of those 2 characters (aka `EOL` or `\\r\\n`)\n"}}}} ``` ## The ColumnNameFilters object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ColumnNameFilters":{"type":"array","items":{"type":"string"},"default":[],"description":"The `Data Class` is considered only if the column name is a full or partial match with the value of this property.\n\nIt is not case sensitive and it is using a text match (not a regular expression).\n\nAny match will make the `Data Class` considered.\n"}}}} ``` ## The ColumnTypeFilters object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ColumnTypeFilters":{"type":"array","items":{"type":"string"},"default":[],"description":"The `Data Class` can only be considered if the column technical data type is part of the values defined for this property.\n\nValid values are: `string`, `double`, `int`, `boolean`, `date`, and `timestamp`.\n"}}}} ``` ## The AllowNullValues object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"AllowNullValues":{"type":"boolean","description":"If the value is set to `true`, null values are considered when calculating the confidence level of a matching `Data Class`.\n\nIf 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`.\n","default":false}}}} ``` ## The AllowEmptyValues object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"AllowEmptyValues":{"type":"boolean","description":"If 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`.\n\nIf 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`.\n","default":false}}}} ``` ## The ConfidenceThreshold object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ConfidenceThreshold":{"type":"integer","description":"The Data Class is only considered in the result if this confidence threshold is reached.","default":0,"minimum":0,"maximum":100}}}} ``` ## The ValueCount object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0}}}} ``` ## The Examples object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"Examples":{"type":"array","default":[],"items":{"type":"string"},"description":"Examples of values that match the `Data Class`.\n"}}}} ``` ## The DataClassGroupId object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"DataClassGroupId":{"type":"string","format":"uuid","description":"The ID of the `Data Class Group`.\n"}}}} ``` ## The DataClassGroupName object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"DataClassGroupName":{"type":"string","description":"Name of the `Data Class Group`.\n"}}}} ``` ## The CreatedBy object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"CreatedBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"}}}} ``` ## The CreatedOn object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"CreatedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"}}}} ``` ## The LastModifiedBy object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"LastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"}}}} ``` ## The LastModifiedOn object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"LastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"}}}} ``` ## The StandardErrorResponse object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"StandardErrorResponse":{"type":"object","properties":{"statusCode":{"type":"integer","description":"An HTTP response code."},"titleMessage":{"type":"string","description":"A translated message."},"helpMessage":{"type":"string","description":"A translated message."},"userMessage":{"type":"string","description":"A translated message."},"errorCode":{"type":"string","description":"An error code. This error code is not translated."}}}}}} ``` ## The OotbDataClass object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"OotbDataClass":{"type":"object","required":["name","status","types"],"properties":{"name":{"type":"string","description":"The name of OOTB Data Class"},"status":{"type":"string","description":"The import status of OOTB Data Class.\n\nValues can be:\n- `NEW`\n- `EXISTS`\n- `EXISTS-DIFFERENT`\n"},"types":{"type":"array","items":{"type":"string"},"description":"Types of rules currently associated to the OOTB Data Class if any\n"}}}}}} ``` ## The OotbDataClassPagedResponse object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"OotbDataClassPagedResponse":{"type":"object","required":["results"],"properties":{"results":{"type":"array","description":"List of OOTB Data Classes paginated","items":{"$ref":"#/components/schemas/OotbDataClass"}}}},"OotbDataClass":{"type":"object","required":["name","status","types"],"properties":{"name":{"type":"string","description":"The name of OOTB Data Class"},"status":{"type":"string","description":"The import status of OOTB Data Class.\n\nValues can be:\n- `NEW`\n- `EXISTS`\n- `EXISTS-DIFFERENT`\n"},"types":{"type":"array","items":{"type":"string"},"description":"Types of rules currently associated to the OOTB Data Class if any\n"}}}}}} ``` ## The DataClasses object ```json {"openapi":"3.0.3","info":{"title":"Collibra Classification - Data Class API","version":"0.0.3"},"components":{"schemas":{"DataClasses":{"type":"array","description":"Out-of-the-box Data Classes import response","items":{"$ref":"#/components/schemas/DataClass"}},"DataClass":{"type":"object","required":["id","name","status","allowNullValues","allowEmptyValues","confidenceThreshold","createdBy","createdOn","lastModifiedBy","lastModifiedOn"],"properties":{"id":{"$ref":"#/components/schemas/DataClassId"},"name":{"$ref":"#/components/schemas/DataClassName"},"description":{"$ref":"#/components/schemas/DataClassDescription"},"status":{"$ref":"#/components/schemas/DataClassStatus"},"columnNameFilters":{"$ref":"#/components/schemas/ColumnNameFilters"},"columnTypeFilters":{"$ref":"#/components/schemas/ColumnTypeFilters"},"allowNullValues":{"$ref":"#/components/schemas/AllowNullValues"},"allowEmptyValues":{"$ref":"#/components/schemas/AllowEmptyValues"},"confidenceThreshold":{"$ref":"#/components/schemas/ConfidenceThreshold"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdOn":{"$ref":"#/components/schemas/CreatedOn"},"lastModifiedBy":{"$ref":"#/components/schemas/LastModifiedBy"},"lastModifiedOn":{"$ref":"#/components/schemas/LastModifiedOn"},"rules":{"$ref":"#/components/schemas/ClassificationRules"}}},"DataClassId":{"type":"string","format":"uuid","description":"The ID of the `Data Class`.\n"},"DataClassName":{"type":"string","description":"Name of the `Data Class`.\n"},"DataClassDescription":{"type":"string","description":"The description of the `Data Class`. The maximum length of this field is set to 10,000 characters.\n"},"DataClassStatus":{"type":"string","description":"The status of a `Data Class`.\n\nThis attribute allows a `Data Class` to be `ENABLED` or `DISABLED`.\nAn `DISABLED` `Data Class` will never be used as part of the classification process.\n\nPossible values:\n- `ENABLED`\n- `DISABLED`\n"},"ColumnNameFilters":{"type":"array","items":{"type":"string"},"default":[],"description":"The `Data Class` is considered only if the column name is a full or partial match with the value of this property.\n\nIt is not case sensitive and it is using a text match (not a regular expression).\n\nAny match will make the `Data Class` considered.\n"},"ColumnTypeFilters":{"type":"array","items":{"type":"string"},"default":[],"description":"The `Data Class` can only be considered if the column technical data type is part of the values defined for this property.\n\nValid values are: `string`, `double`, `int`, `boolean`, `date`, and `timestamp`.\n"},"AllowNullValues":{"type":"boolean","description":"If the value is set to `true`, null values are considered when calculating the confidence level of a matching `Data Class`.\n\nIf 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`.\n","default":false},"AllowEmptyValues":{"type":"boolean","description":"If 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`.\n\nIf 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`.\n","default":false},"ConfidenceThreshold":{"type":"integer","description":"The Data Class is only considered in the result if this confidence threshold is reached.","default":0,"minimum":0,"maximum":100},"CreatedBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"CreatedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"LastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"LastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"ClassificationRules":{"type":"array","description":"`Classification Rules` defined for the `Data Class`.\n","items":{"$ref":"#/components/schemas/ClassificationRuleWithId"}},"ClassificationRuleWithId":{"description":"A `ClassificationRule` defines a read-only representation of a rule.\n","oneOf":[{"$ref":"#/components/schemas/SingleValuedClassificationRuleWithId"},{"$ref":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/DataTypeBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/ListOfValuesBasedClassificationRuleWithId"},{"$ref":"#/components/schemas/BetweenClassificationRuleWithId"},{"$ref":"#/components/schemas/CodeSetBasedClassificationRuleWithId"}],"discriminator":{"propertyName":"type","mapping":{"REGULAR_EXPRESSION":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId","REGULAR_EXPRESSION_COLUMN_NAME":"#/components/schemas/RegularExpressionBasedClassificationRuleWithId","DATA_TYPE":"#/components/schemas/DataTypeBasedClassificationRuleWithId","LIST_OF_VALUES":"#/components/schemas/ListOfValuesBasedClassificationRuleWithId","CODE_SET":"#/components/schemas/CodeSetBasedClassificationRuleWithId","LIKE":"#/components/schemas/SingleValuedClassificationRuleWithId","GREATER_THAN":"#/components/schemas/SingleValuedClassificationRuleWithId","LESS_THAN":"#/components/schemas/SingleValuedClassificationRuleWithId","EQUAL":"#/components/schemas/SingleValuedClassificationRuleWithId","BETWEEN":"#/components/schemas/BetweenClassificationRuleWithId"}}},"SingleValuedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/SingleValuedClassificationRule"}]},"BaseClassificationRuleWithId":{"type":"object","required":["id","createdBy","createdOn","lastModifiedBy","lastModifiedOn"],"properties":{"id":{"$ref":"#/components/schemas/ClassificationRuleId"},"createdBy":{"$ref":"#/components/schemas/CreatedBy"},"createdOn":{"$ref":"#/components/schemas/CreatedOn"},"lastModifiedBy":{"$ref":"#/components/schemas/LastModifiedBy"},"lastModifiedOn":{"$ref":"#/components/schemas/LastModifiedOn"}}},"ClassificationRuleId":{"type":"string","format":"uuid","description":"The ID of a `Classification Rule`.\n"},"SingleValuedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseSingleValuedClassificationRule"}]},"BaseClassificationRule":{"type":"object","required":["type","dataClassId"],"properties":{"type":{"$ref":"#/components/schemas/RuleType"},"dataClassId":{"$ref":"#/components/schemas/DataClassId"},"description":{"$ref":"#/components/schemas/ClassificationRuleDescription"}}},"RuleType":{"type":"string","description":"RuleType used by the rule.\n\nThe following values are currently supported:\n - `REGULAR_EXPRESSION`\n - `REGULAR_EXPRESSION_COLUMN_NAME`\n - `DATA_TYPE`\n - `LIST_OF_VALUES`\n - `CODE_SET`\n - `LIKE`\n - `GREATER_THAN`\n - `LESS_THAN` \n - `EQUAL`\n - `BETWEEN`\n\nWhen **creating** or **updating** a `Classification Rule`, the following values are also supported:\n - `LIST_OF_VALUES_INLINE_ARRAY`\n - `LIST_OF_VALUES_INLINE_CSV`\n\nThese additional types are automatically converted into `LIST_OF_VALUES` and will be retrieved as such with GET endpoints.\n"},"ClassificationRuleDescription":{"type":"string","description":"A description of a `Classification Rule`.\n"},"BaseSingleValuedClassificationRule":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/Value"}}},"Value":{"type":"string","description":"Value used by the `Classification Rule`.\n"},"RegularExpressionBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/RegularExpressionBasedClassificationRule"}]},"RegularExpressionBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseRegularExpressionBasedClassificationRule"}]},"BaseRegularExpressionBasedClassificationRule":{"type":"object","properties":{"regularExpression":{"$ref":"#/components/schemas/RegularExpression"}}},"RegularExpression":{"type":"string","description":"A regular expression. The maximum length of this field is set to 10,000 characters.\n"},"DataTypeBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/DataTypeBasedClassificationRule"}]},"DataTypeBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseDataTypeBasedClassificationRule"}]},"BaseDataTypeBasedClassificationRule":{"type":"object","properties":{"dataTypes":{"type":"array","description":"The list of data types defining this rule.","items":{"$ref":"#/components/schemas/DataType"}}}},"DataType":{"type":"string","description":"A data type.\n"},"ListOfValuesBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/ListOfValuesBasedClassificationRule"}]},"ListOfValuesBasedClassificationRule":{"description":"`Classification Rule` based on a `List Of Values`.\n","allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseListOfValuesBasedClassificationRule"}]},"BaseListOfValuesBasedClassificationRule":{"type":"object","properties":{"listOfValues":{"$ref":"#/components/schemas/ListOfValues"}}},"ListOfValues":{"type":"object","properties":{"valueCount":{"$ref":"#/components/schemas/ValueCount"},"firstValues":{"$ref":"#/components/schemas/FirstValues"}}},"ValueCount":{"type":"integer","description":"The number of values defined in the rule","default":0,"minimum":0},"FirstValues":{"type":"array","items":{"type":"string"},"maxItems":1000,"description":"Values defined as an array of strings. Contains the first 1,000 values.\n"},"BetweenClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/BetweenClassificationRule"}]},"BetweenClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseBetweenClassificationRule"}]},"BaseBetweenClassificationRule":{"type":"object","properties":{"minValueInclusive":{"$ref":"#/components/schemas/Value"},"maxValueInclusive":{"$ref":"#/components/schemas/Value"}}},"CodeSetBasedClassificationRuleWithId":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRuleWithId"},{"$ref":"#/components/schemas/CodeSetBasedClassificationRule"}]},"CodeSetBasedClassificationRule":{"allOf":[{"$ref":"#/components/schemas/BaseClassificationRule"},{"$ref":"#/components/schemas/BaseCodeSetBasedClassificationRule"}]},"BaseCodeSetBasedClassificationRule":{"type":"object","properties":{"codeSet":{"$ref":"#/components/schemas/CodeSet"}}},"CodeSet":{"type":"object","description":"Represents a `Code Set` asset.\n","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/CodeSetId"},"valueCount":{"$ref":"#/components/schemas/ValueCount"}}},"CodeSetId":{"type":"string","format":"uuid","description":"The ID of a `Code Set` asset defined.\n"}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developer.collibra.com/api/references/data-class-management/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.