Data Classification

Classification of data operations

Deprecated

Finds Classification Matches

get

Returns Classification Matches matching the given search criteria defined by request. Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored. The returned Classification Matches satisfy all constraints that are specified in this search criteria. This endpoint will be removed in the next major release. Please, use GET /bulk

Authorizations

AuthorizationstringRequired

Body

The search criteria for finding classification matches.

offsetinteger · int32Optional

limitinteger · int32Optional

countLimitinteger · int32Optional

assetIdsstring · uuid[]Optional

classificationIdsstring · uuid[]Optional

assetTypeIdsstring · uuid[]Optional

Responses

200

The found Classification Matches.

application/json

Response containing the paged information.

totalinteger · int64Optional

The total number of results.

Example: 1000

offsetinteger · int64Optional

The offset for the results.

Example: 10

limitinteger · int64Optional

The maximum number of results to be returned.

Example: 100

get/dataClassification/classificationMatches

GET /rest/catalog/1.0/dataClassification/classificationMatches HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "offset": 1,
  "limit": 1,
  "countLimit": 1,
  "assetIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "statuses": [
    "ACCEPTED"
  ],
  "classificationIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "assetTypeIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

200

The found Classification Matches.

{
  "total": 1000,
  "offset": 10,
  "limit": 100,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "status": "SUGGESTED",
      "confidence": 0.56,
      "asset": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "classification": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "name": "Test name"
      }
    }
  ]
}

Adds new Classification Match

post

Authorizations

AuthorizationstringRequired

Body

Request for adding classification match.

assetIdstring · uuidRequired

The id of an asset for which classification matches will be added.

classificationIdstring · uuidRequired

The id of classification to be used in created classification match.

Responses

201

Newly created Classification Match.

application/json

Represents match between classification of data and an asset.

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

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

Example: 1475503010320

lastModifiedBystring · uuidOptional

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

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

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

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

statusstringOptional

The status of data classification match assigned to an asset.

Example: SUGGESTED

confidencenumber · doubleOptional

The confidence of the data classification match between classification and an asset.

Example: 0.56

404

Classification or Asset not found.

application/json

422

Classification Match between provided Asset and Classification already exist.

application/json

post/dataClassification/classificationMatches

POST /rest/catalog/1.0/dataClassification/classificationMatches HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "assetId": "123e4567-e89b-12d3-a456-426614174000",
  "classificationId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "status": "SUGGESTED",
  "confidence": 0.56,
  "asset": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "classification": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "name": "Test name"
  }
}

Finds Classification Matches

get

Returns Classification Matches matching the given search criteria defined by query params that form the request. Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored. The returned Classification Matches satisfy all constraints that are specified in this search criteria.

Authorizations

AuthorizationstringRequired

Query parameters

offsetinteger · int32Optional

The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.

Default: 0

limitinteger · int32Optional

The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.

Default: 0

countLimitinteger · int32Optional

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

Default: -1

assetIdsstring · uuid[]Optional

The ids of the assets (with Column types) to filter by the search results

classificationIdsstring · uuid[]Optional

The list of classification ids to filter by the search results.

assetTypeIdsstring · uuid[]Optional

The list of asset type ids to filter by the search results.

Responses

200

The found Classification Matches.

application/json

Response containing the paged information.

totalinteger · int64Optional

The total number of results.

Example: 1000

offsetinteger · int64Optional

The offset for the results.

Example: 10

limitinteger · int64Optional

The maximum number of results to be returned.

Example: 100

get/dataClassification/classificationMatches/bulk

GET /rest/catalog/1.0/dataClassification/classificationMatches/bulk HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

The found Classification Matches.

{
  "total": 1000,
  "offset": 10,
  "limit": 100,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "status": "SUGGESTED",
      "confidence": 0.56,
      "asset": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "classification": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "name": "Test name"
      }
    }
  ]
}

Adds new Classification Matches

post

Authorizations

AuthorizationstringRequired

Body

Request for adding classification matches for many classes.

assetIdstring · uuidRequired

The id of an asset for which classification matches will be added.

classificationIdsstring · uuid[]Required

The list of id of classifications to be used in created classification matches.

Responses

201

Newly created Classification Matches.

application/json

Represents match between classification of data and an asset.

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

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

Example: 1475503010320

lastModifiedBystring · uuidOptional

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

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

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

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

statusstringOptional

The status of data classification match assigned to an asset.

Example: SUGGESTED

confidencenumber · doubleOptional

The confidence of the data classification match between classification and an asset.

Example: 0.56

404

Classification or Asset not found.

application/json

422

Classification Match between provided Asset and Classification already exist.

application/json

post/dataClassification/classificationMatches/bulk

POST /rest/catalog/1.0/dataClassification/classificationMatches/bulk HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "assetId": "123e4567-e89b-12d3-a456-426614174000",
  "classificationIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "status": "SUGGESTED",
  "confidence": 0.56,
  "asset": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "classification": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "name": "Test name"
  }
}

Removes multiple Classification Matches

delete

Removes multiple Classification Matches with IDs provided in request body.

Authorizations

AuthorizationstringRequired

Body

The request for deleting classification match.

classificationMatchIdsstring · uuid[]Optional

The list of classification match ids.

Responses

204

Removed all Classification Matches with given IDs.

No content

404

At least one of the Classification Matches to be deleted was not found.

delete/dataClassification/classificationMatches/bulk

DELETE /rest/catalog/1.0/dataClassification/classificationMatches/bulk HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "classificationMatchIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

No content

Changes multiple Classification Matches

patch

Changes multiple Classification Matches with the information that is present in the requests. Only properties that are specified in the requests and have not null values are updated. All other properties are ignored.

Authorizations

AuthorizationstringRequired

Bodyobject · ChangeClassificationMatchRequest[]

The criteria for changing classification match.

classificationMatchIdstring · uuidOptional

The id of the classification match.

statusstring · enumOptional

The status to be set on classification match with given id. Only possible choices : ACCEPTED, REJECTED.

Possible values:

confidencenumber · doubleOptional

The confidence level between 0-1 which the current match is assigned with.

Responses

200

The changed Classification Matches.

application/json

Represents match between classification of data and an asset.

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

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

Example: 1475503010320

lastModifiedBystring · uuidOptional

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

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

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

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

statusstringOptional

The status of data classification match assigned to an asset.

Example: SUGGESTED

confidencenumber · doubleOptional

The confidence of the data classification match between classification and an asset.

Example: 0.56

404

Classification Match(es) not found.

patch/dataClassification/classificationMatches/bulk

PATCH /rest/catalog/1.0/dataClassification/classificationMatches/bulk HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 101

[
  {
    "classificationMatchId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "ACCEPTED",
    "confidence": 1
  }
]

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "status": "SUGGESTED",
    "confidence": 0.56,
    "asset": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    },
    "classification": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "name": "Test name"
    }
  }
]

Gets existing Classification Match by id.

get

Authorizations

AuthorizationstringRequired

Path parameters

classificationMatchIdstring · uuidRequired

The id of the Classification Match to be fetched

Responses

404

Classification Match not found.

No content

get/dataClassification/classificationMatches/{classificationMatchId}

GET /rest/catalog/1.0/dataClassification/classificationMatches/{classificationMatchId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

404

Classification Match not found.

No content

Removes existing Classification Match.

delete

Authorizations

AuthorizationstringRequired

Path parameters

classificationMatchIdstring · uuidRequired

The id of the Classification Match to be deleted

Responses

204

Removed Classification Match.

No content

404

Classification Match not found.

delete/dataClassification/classificationMatches/{classificationMatchId}

DELETE /rest/catalog/1.0/dataClassification/classificationMatches/{classificationMatchId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Changes a Classification Match

patch

Changes the Classification Match with the information that is present in the request. Only properties that are specified in this request and have not null values are updated. All other properties are ignored.

Authorizations

AuthorizationstringRequired

Path parameters

classificationMatchIdstring · uuidRequired

The id of the Classification Match to be changed

Body

The criteria for changing classification match.

classificationMatchIdstring · uuidOptional

The id of the classification match.

statusstring · enumOptional

The status to be set on classification match with given id. Only possible choices : ACCEPTED, REJECTED.

Possible values:

confidencenumber · doubleOptional

The confidence level between 0-1 which the current match is assigned with.

Responses

200

The changed Classification Match.

application/json

Represents match between classification of data and an asset.

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

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

Example: 1475503010320

lastModifiedBystring · uuidOptional

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

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

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

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

statusstringOptional

The status of data classification match assigned to an asset.

Example: SUGGESTED

confidencenumber · doubleOptional

The confidence of the data classification match between classification and an asset.

Example: 0.56

404

Classification Match not found.

patch/dataClassification/classificationMatches/{classificationMatchId}

PATCH /rest/catalog/1.0/dataClassification/classificationMatches/{classificationMatchId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "classificationMatchId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "ACCEPTED",
  "confidence": 1
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "status": "SUGGESTED",
  "confidence": 0.56,
  "asset": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "classification": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "name": "Test name"
  }
}

Deprecated

Finds Classifications

get

Returns Classifications matching the given search criteria defined by request. Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored. The returned Classifications satisfy all constraints that are specified in this search criteria. This endpoint will be removed in the next major release. Please, use GET /bulk

Required scopes

This endpoint requires the following scopes:

: Use Collibra Catalog.
: Read data classes.

: Use Collibra Catalog.

Authorizations

OAuth2clientCredentialsRequired

Collibra REST API authentication using OAuth 2.

Token URL:

Body

The search criteria for finding classification.

offsetinteger · int32Optional

limitinteger · int32Optional

countLimitinteger · int32Optional

namestringOptional

Responses

200

The found Classifications.

application/json

totalinteger · int64Optional

The total number of results.

Example: 1000

offsetinteger · int64Optional

The offset for the results.

Example: 10

limitinteger · int64Optional

The maximum number of results to be returned.

Example: 100

get/dataClassification/classifications

GET /rest/catalog/1.0/dataClassification/classifications HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "offset": 1,
  "limit": 1,
  "countLimit": 1,
  "name": "text"
}

200

The found Classifications.

{
  "total": 1000,
  "offset": 10,
  "limit": 100,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "name": "Test name"
    }
  ]
}

Adds new Classification

post

Required scopes

This endpoint requires the following scopes:

: Use Collibra Catalog.
: Add advanced data types.
: Add data classes.
: Read data classes.

: Use Collibra Catalog.
: Add data classes.
: Read data classes.

: Use Collibra Catalog.
: Add advanced data types.

Authorizations

OAuth2clientCredentialsRequired

Collibra REST API authentication using OAuth 2.

Token URL:

Body

Request to add Classification

namestringRequired

New Classification name

Responses

201

Newly created Classification.

application/json

Represents classification of data.

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

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

Example: 1475503010320

lastModifiedBystring · uuidOptional

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

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

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

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

namestringOptional

The name of the resource.

Example: Test name

post/dataClassification/classifications

POST /rest/catalog/1.0/dataClassification/classifications HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

201

Newly created Classification.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name"
}

Gets existing Classification by id.

get

Required scopes

This endpoint requires the following scopes:

: Use Collibra Catalog.
: Read data classes.

: Use Collibra Catalog.

Authorizations

OAuth2clientCredentialsRequired

Collibra REST API authentication using OAuth 2.

Token URL:

Path parameters

classificationIdstring · uuidRequired

Responses

404

Classification not found.

No content

get/dataClassification/classifications/{classificationId}

GET /rest/catalog/1.0/dataClassification/classifications/{classificationId} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

404

Classification not found.

No content

Removes existing Classification. WARNING: This will also remove all ClassificationMatches that are joined with this Classification!

delete

Required scopes

This endpoint requires the following scopes:

: Use Collibra Catalog.
: Remove advanced data types.
: Read data classes.
: Remove data classes.

: Use Collibra Catalog.
: Read data classes.
: Remove data classes.

: Use Collibra Catalog.
: Remove advanced data types.

Authorizations

OAuth2clientCredentialsRequired

Collibra REST API authentication using OAuth 2.

Token URL:

Path parameters

classificationIdstring · uuidRequired

Responses

204

Removed Classification.

No content

404

Classification not found.

delete/dataClassification/classifications/{classificationId}

DELETE /rest/catalog/1.0/dataClassification/classifications/{classificationId} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Changes existing Classification

patch

Required scopes

This endpoint requires the following scopes:

: Use Collibra Catalog.
: Edit advanced data types.
: Edit data classes.
: Read data classes.

: Use Collibra Catalog.
: Edit data classes.
: Read data classes.

: Use Collibra Catalog.
: Edit advanced data types.

Authorizations

OAuth2clientCredentialsRequired

Collibra REST API authentication using OAuth 2.

Token URL:

Path parameters

classificationIdstring · uuidRequired

The id of the Classification to be changed

Body

Request to change Classification

namestringOptional

New name

Responses

200

Changed Classification.

application/json

Represents classification of data.

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

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

Example: 1475503010320

lastModifiedBystring · uuidOptional

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

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

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

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

namestringOptional

The name of the resource.

Example: Test name

404

Classification not found.

patch/dataClassification/classifications/{classificationId}

PATCH /rest/catalog/1.0/dataClassification/classifications/{classificationId} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name"
}

Starts a job that classifies datasets, databases, schemas, tables or columns by external service based on sample data.

post

Required scopes

This endpoint requires the following scopes:

: Use Collibra Catalog.
: Perform classification.
: Manage all knowledge graph resources.

: Use Collibra Catalog.
: Manage all knowledge graph resources.

Authorizations

OAuth2clientCredentialsRequired

Collibra REST API authentication using OAuth 2.

Token URL:

Body

Request to classify data.

assetIdsstring · uuid[]Optional

Ids of assets (with Column, Table, Schema, Database or DataSet type) that will be classified.

dataClassIdsstring · uuid[]Optional

Responses

404

Asset to classify not found.

No content

post/dataClassification/classifications/classify

POST /rest/catalog/1.0/dataClassification/classifications/classify HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "assetIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "dataClassIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

404

Asset to classify not found.

No content

Finds Classifications

get

Returns Classifications matching the given search criteria defined by query params that form the request. Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored. The returned Classifications satisfy all constraints that are specified in this search criteria.

Required scopes

This endpoint requires the following scopes:

: Use Collibra Catalog.
: Read data classes.

: Use Collibra Catalog.

Authorizations

OAuth2clientCredentialsRequired

Collibra REST API authentication using OAuth 2.

Token URL:

Query parameters

offsetinteger · int32Optional

The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.

Default: 0

limitinteger · int32Optional

The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.

Default: 0

countLimitinteger · int32Optional

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

Default: -1

namestringOptional

The exact name of classification to filter by the search results.

Responses

200

The found Classifications.

application/json

totalinteger · int64Optional

The total number of results.

Example: 1000

offsetinteger · int64Optional

The offset for the results.

Example: 10

limitinteger · int64Optional

The maximum number of results to be returned.

Example: 100

get/dataClassification/classifications/bulk

GET /rest/catalog/1.0/dataClassification/classifications/bulk HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

The found Classifications.

{
  "total": 1000,
  "offset": 10,
  "limit": 100,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "name": "Test name"
    }
  ]
}

PreviousCatalog Data Classification REST API (Version 1)NextModels

Last updated 25 days ago

Was this helpful?