classifier

Get all classifiers

Securityapi_key
Request
query Parameters
page_number
integer <int64>
Default: 1

The page number for which to get classifiers. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

Responses
200

Success

400

Bad request

get/classifiers
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create classifier

Securityapi_key
Request
Request Body schema: application/json
required

The classifier to create

classifierName
required
string <= 100 characters

The name of this classifier. Note that it must be unique.

description
string

The description of the classifier.

frameworkId
integer <int64>

The id of the classifier framework.

domainName
string <= 20 characters

The name of the domain that will be assigned to the column/field when a profile expression match is found during the execution of a profile job.

classifierConfiguration
object
Responses
201

Success

400

Bad request

409

Conflict

post/classifiers
Request samples
application/json
{
  • "classifierName": "MyClassifier",
  • "description": "Detects my sensitive data",
  • "frameworkId": 1,
  • "domainName": "MyDomain",
  • "classifierConfiguration": {
    }
}
Response samples
application/json
{
  • "classifierName": "MyClassifier",
  • "description": "Detects my sensitive data",
  • "frameworkId": 1,
  • "domainName": "MyDomain",
  • "classifierConfiguration": {
    }
}

Get classifier by ID

Securityapi_key
Request
path Parameters
classifierId
required
integer <int64>

The ID of the classifier to get

Responses
200

Success

401

Unauthorized access

404

Not found

get/classifiers/{classifierId}
Response samples
application/json
{
  • "classifierName": "MyClassifier",
  • "description": "Detects my sensitive data",
  • "frameworkId": 1,
  • "domainName": "MyDomain",
  • "classifierConfiguration": {
    }
}

Update classifier by ID

Securityapi_key
Request
path Parameters
classifierId
required
integer <int64>

The ID of the classifier to update

Request Body schema: application/json
required

The classifier

classifierName
required
string <= 100 characters

The name of this classifier. Note that it must be unique.

description
string

The description of the classifier.

frameworkId
integer <int64>

The id of the classifier framework.

domainName
string <= 20 characters

The name of the domain that will be assigned to the column/field when a profile expression match is found during the execution of a profile job.

classifierConfiguration
object
Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

put/classifiers/{classifierId}
Request samples
application/json
{
  • "classifierName": "MyClassifier",
  • "description": "Detects my sensitive data",
  • "frameworkId": 1,
  • "domainName": "MyDomain",
  • "classifierConfiguration": {
    }
}
Response samples
application/json
{
  • "classifierName": "MyClassifier",
  • "description": "Detects my sensitive data",
  • "frameworkId": 1,
  • "domainName": "MyDomain",
  • "classifierConfiguration": {
    }
}

Delete classifier by ID

Securityapi_key
Request
path Parameters
classifierId
required
integer <int64>

The ID of the classifier to delete

Responses
200

Success

400

Bad request

401

Unauthorized access

404

Not found

delete/classifiers/{classifierId}

Copy classifier by ID

Securityapi_key
Request
path Parameters
classifierId
required
integer <int64>

The ID of the classifier to copy

Request Body schema: application/json
required

The name of the classifier to create

newClassifierName
required
string <= 201 characters

The name of the classifier. This must be unique.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

post/classifiers/{classifierId}/copy
Request samples
application/json
{
  • "newClassifierName": "NewClassifier"
}
Response samples
application/json
{
  • "classifierName": "MyClassifier",
  • "description": "Detects my sensitive data",
  • "frameworkId": 1,
  • "domainName": "MyDomain",
  • "classifierConfiguration": {
    }
}

Export a zip file containing the files used for the specified classifier

Securityapi_key
Request
path Parameters
classifierId
required
integer <int64>

The ID of the classifier

Responses
201

Success

400

Bad request

401

Unauthorized access

404

Not found

post/classifiers/{classifierId}/export-files
Response samples
application/json
{
  • "asyncTaskId": 1,
  • "operation": "RULESET_REFRESH",
  • "reference": 13,
  • "status": "RUNNING",
  • "cancellable": false
}

Get all classifier frameworks

Securityapi_key
Request
query Parameters
include_schema
boolean
Default: false

Whether to include each classifier framework's JSON schema in the response.

page_number
integer <int64>
Default: 1

The page number for which to get classifier frameworks. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

Responses
200

Success

400

Bad request

403

Forbidden access

get/classifiers/frameworks
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Get classifier framework by frameworkId

Securityapi_key
Request
path Parameters
frameworkId
required
integer <int64>

The id of the framework

query Parameters
include_schema
boolean
Default: false

Whether to include each classifier framework's JSON schema in the response.

Responses
200

Success

400

Bad request

403

Forbidden access

get/classifiers/frameworks/{frameworkId}
Response samples
application/json
{
  • "frameworkId": 1,
  • "frameworkName": "REGEX",
  • "description": "This is a regex classifier framework."
}

Search classifiers

Securityapi_key
Request
query Parameters
page_number
integer <int64>
Default: 1

The page number for which to get classifiers. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

sort
string

The field to sort results by. A property name with a prepended '-' signifies a descending order.

Enum: "classifierId" "-classifierId" "classifierName" "-classifierName" "frameworkId" "-frameworkId" "createdDate" "-createdDate" "domainName" "-domainName" "description" "-description"
Request Body schema: application/json
optional

A request body containing a filter expression. Refer to the documentation to learn the syntax for filter-queries. Supported filterable attributes: "classifierId", "classifierName", "frameworkId", "createdDate", "domainName", "description"

Responses
200

Success

400

Bad request

409

Conflict

post/classifiers/search
Request samples
application/json
{
  • "filter_expression": "<attribute> EQ 123"
}
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}
➔ Next to columnMetadata