Ctrlk
Request a demo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Classification Rule

Management of Classification Rules.

Find Classification Rules

get

Finds Classification Rules based on the provided criteria.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Query parameters
dataClassIdstring · uuidOptional

The ID of a Data Class.

offsetinteger · int32Optional

The index of the first result to retrieve.

If not set (offset = 0), results will be retrieved starting from row 0.

Default: 0
limitinteger · int32 · max: 1000Optional

The maximum number of results to retrieve.

If not set, the default limit (limit = 50) will be used. The maximum value for this parameter is 1000.

Default: 50
correlationIdstring · uuidOptional

Correlation ID used to relate logs occurring in distinct system components.

Responses
200

Classification Rules successfully retrieved.

application/json
get/classificationRules

Creates a new Classification Rule.

post

Create a new Classification Rule under a given Data Class.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Query parameters
correlationIdstring · uuidOptional

Correlation ID used to relate logs occurring in distinct system components.

Body

Request to create a Classification Rule under an existing Data Class.

Only the type and dataClassId properties are mandatory when creating a new Classification Rule.

or
or
or
or
or
or
Responses
201

Classification Rule successfully created.

application/json
Responseone of

A ClassificationRule defines a read-only representation of a rule.

or
or
or
or
or
post/classificationRules

Get a Classification Rule

get

Returns a specific Classification Rule.

For the Classification Rules of type LIST_OF_VALUES, this endpoint only returns a summary of the List Of Values. This summary includes the following information:

  • The identifier of the list (id)

  • The number of values (valueCount)

  • The first 1,000 values (firstValues).

To retrieve all the values defined inside a specific List Of Values, the following endpoints can be used:

  • /classificationRules/{classificationRuleId}/values, which returns the values in a JSON document. This endpoint supports pagination.

  • /classificationRules/{classificationRuleId}/valuesAsFile, which returns all the values as a file.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
classificationRuleIdstring · uuidRequired

The ID of a Classification Rule.

Query parameters
correlationIdstring · uuidOptional

Correlation ID used to relate logs occurring in distinct system components.

Responses
200

Classification Rule successfully retrieved.

application/json

A ClassificationRule defines a read-only representation of a rule.

or
or
or
or
or
get/classificationRules/{classificationRuleId}

Delete a Classification Rule

delete

Delete a Classification Rule by its identifier.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
classificationRuleIdstring · uuidRequired

The ID of a Classification Rule.

Query parameters
correlationIdstring · uuidOptional

Correlation ID used to relate logs occurring in distinct system components.

Responses
204

Classification Rule successfully deleted.

No content
delete/classificationRules/{classificationRuleId}
No content

Update a Classification Rule

patch

Update an existing Classification Rule.

You can use this endpoint to update a List Of Values that contains maximum 1,000 values. To update a List Of Values that is larger than 1,000 values, use the /listOfValues/{listOfValuesId}/valuesUpload endpoint.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
classificationRuleIdstring · uuidRequired

The ID of a Classification Rule.

Query parameters
correlationIdstring · uuidOptional

Correlation ID used to relate logs occurring in distinct system components.

Body

Request to change a Classification Rule.

or
or
or
or
or
or
Responses
200

The List Of Values was successfully updated.

application/json
Responseone of

A ClassificationRule defines a read-only representation of a rule.

or
or
or
or
or
patch/classificationRules/{classificationRuleId}

Get the values of a Classification Rule as a file

get

Returns the values of a given Classification Rule as a file.

Please note that this endpoint is only applicable to Classification Rules with type LIST_OF_VALUES. If the identified Classification Rule is of a different type, this endpoint returns a 400 response.

The file returned by this endpoint is a text file (text/plain) in which each value is defined as a separate line. The following characters are supported as valid value separators:

  • Carriage return (aka CR or \r)

  • Line feed (aka LF or \n)

  • The end of line sequence composed of those 2 characters (aka EOL or \r\n)

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
classificationRuleIdstring · uuidRequired

The ID of a Classification Rule.

Query parameters
correlationIdstring · uuidOptional

Correlation ID used to relate logs occurring in distinct system components.

Responses
200

Values file successfully returned.

text/plain
Responsestring
get/classificationRules/{classificationRuleId}/valuesAsFile

Update values of a Classification Rule via File Upload

put

Update the List Of Values defined for a specific Classification Rule.

Please note that this endpoint is only applicable to Classification Rules with type LIST_OF_VALUES. If the identified Classification Rule is of a different type, this endpoint returns a 400 response.

This endpoint can be used to upload any List of Values, regardless of its size. However, it must be used to create a List Of Values containing more than 1,000 values.

The file provided to this endpoint must be a text file (text/plain) in which each value is defined as a separate line. The following characters are supported as valid value separators:

  • Carriage return (aka CR or \r)

  • Line feed (aka LF or \n)

  • The end of line sequence composed of those 2 characters (aka EOL or \r\n)

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
classificationRuleIdstring · uuidRequired

The ID of a Classification Rule.

Query parameters
correlationIdstring · uuidOptional

Correlation ID used to relate logs occurring in distinct system components.

Body
filestring · binaryRequired

Files containing the values (1 value per line)

Responses
201

List Of Values successfully updated inside a Classification Rule.

application/json

Classification Rule based on a List Of Values.

idstring · uuidRequired

The ID of a Classification Rule.

createdBystring · uuidRequired

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb
createdOninteger · int64Required

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320
lastModifiedBystring · uuidRequired

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe
lastModifiedOninteger · int64Required

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163
typestringRequired

RuleType used by the rule.

The following values are currently supported:

  • REGULAR_EXPRESSION
  • REGULAR_EXPRESSION_COLUMN_NAME
  • DATA_TYPE
  • LIST_OF_VALUES
  • CODE_SET
  • LIKE
  • GREATER_THAN
  • LESS_THAN
  • EQUAL
  • BETWEEN

When creating or updating a Classification Rule, the following values are also supported:

  • LIST_OF_VALUES_INLINE_ARRAY
  • LIST_OF_VALUES_INLINE_CSV

These additional types are automatically converted into LIST_OF_VALUES and will be retrieved as such with GET endpoints.

Example: REGULAR_EXPRESSION
dataClassIdstring · uuidRequired

The ID of the Data Class.

descriptionstringOptional

A description of a Classification Rule.

Example: Rule based on the email address regular expression.
put/classificationRules/{classificationRuleId}/valuesAsFile

Get the values of a Classification Rule

get

Returns the values defined in the List Of Values of a given Classification Rule. This endpoint provides the ability to retrieve all the values defined for a specific Classification Rule, using paging if required.

Please note that this endpoint is only applicable to Classification Rules with type LIST_OF_VALUES. If the identified Classification Rule is of a different type, this endpoint returns a 400 response.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
classificationRuleIdstring · uuidRequired

The ID of a Classification Rule.

Query parameters
cursorstringOptional

The cursor pointing to the first resource to be included in the response. This cursor cannot be created and must have been extracted from a response returned by a previous API call.

If this parameter is missing, the API will return the resources starting from the first resource available (index=0).

limitinteger · int32 · max: 1000Optional

The maximum number of results to retrieve.

If not set, the default limit (limit = 50) will be used. The maximum value for this parameter is 1000.

Default: 50
Responses
200

Values successfully returned.

application/json
nextCursorstringOptional

An opaque cursor that can be used to query the next page of results.

Example: 234iurjfklsefhr2cil3459jf
resultsstring[]Optional

The list of results.

Example: /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$/.
get/classificationRules/{classificationRuleId}/values
PreviousData ClassNextData Class Group

Last updated

Was this helpful?