Data Class Group

Management of Data Class Groups. Note that these APIs are not yet implemented.

Find Data Class Groups

get

Finds Data Class Groups based on the provided criteria.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Query parameters

namestringOptional

The name of a Data Class Group.

The matching logic is case insensitive and supports partial matches.

E.g. A search for PERSONAL or a search for Identi match Data Class Group name 'Personal Identifiable Information'

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

Responses

200

Data Class Groups successfully retrieved.

application/json

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

500

An unexpected error occurred.

application/json

get/dataClassGroups

HTTPcURLJavaScriptPython

GET /rest/classification/v1/dataClassGroups HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "PII Data Classes",
      "dataClasses": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

Create a Data Class Group

post

Creates a Data Class Group.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Body

application/json

Request to create a Data Class Group.

Only the name property is mandatory. If no data classes are defined, the group is created empty.

namestringRequired

Name of the Data Class Group.

Example: PII Data Classes

dataClassesstring · uuid[]Optional

IDs of the Data Classes contained in the Data Class Group.

Responses

201

Data Class Group successfully created.

application/json

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

500

An unexpected error occurred.

application/json

post/dataClassGroups

HTTPcURLJavaScriptPython

POST /rest/classification/v1/dataClassGroups HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "name": "PII Data Classes",
  "dataClasses": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "PII Data Classes",
  "dataClasses": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Get a Data Class Group

get

Get a single Data Class Group by its identifier.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

dataClassGroupIdstring · uuidRequired

The ID of a Data Class Group.

Responses

200

Data Class Group successfully retrieved.

application/json

Group of Data Classes.

idstring · uuidRequired

The ID of the Data Class Group.

namestringRequired

Name of the Data Class Group.

Example: PII Data Classes

dataClassesstring · uuid[]Required

IDs of the Data Classes contained in the Data Class Group.

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

An unexpected error occurred.

application/json

get/dataClassGroups/{dataClassGroupId}

HTTPcURLJavaScriptPython

GET /rest/classification/v1/dataClassGroups/{dataClassGroupId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "PII Data Classes",
  "dataClasses": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Delete a Data Class Group

delete

Delete a Data Class Group by its identifier.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

dataClassGroupIdstring · uuidRequired

The ID of a Data Class Group.

Responses

204

Data Class Group successfully deleted.

No content

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

An unexpected error occurred.

application/json

delete/dataClassGroups/{dataClassGroupId}

HTTPcURLJavaScriptPython

DELETE /rest/classification/v1/dataClassGroups/{dataClassGroupId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Update a Data Class Group.

patch

Update attributes of a Data Class Group.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

dataClassGroupIdstring · uuidRequired

The ID of a Data Class Group.

Body

application/json

Request to update a Data Class Group.

All the attributes are optional.

namestringOptional

Name of the Data Class Group.

Example: PII Data Classes

dataClassesstring · uuid[]Optional

IDs of the Data Classes contained in the Data Class Group.

Responses

200

Data Class Group successfully changed.

application/json

Group of Data Classes.

idstring · uuidRequired

The ID of the Data Class Group.

namestringRequired

Name of the Data Class Group.

Example: PII Data Classes

dataClassesstring · uuid[]Required

IDs of the Data Classes contained in the Data Class Group.

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

An unexpected error occurred.

application/json

patch/dataClassGroups/{dataClassGroupId}

HTTPcURLJavaScriptPython

PATCH /rest/classification/v1/dataClassGroups/{dataClassGroupId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "name": "PII Data Classes",
  "dataClasses": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "PII Data Classes",
  "dataClasses": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}