profileExpression

Get all profile expressions

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

The page number for which to get profile expressions. 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/profile-expressions
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create profile expression

Securityapi_key
Request
Request Body schema: application/json
required

The profile expression to create

domainName
required
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.

expressionName
required
string <= 255 characters

The name of the profile expression; it must be unique.

regularExpression
required
string <= 1000 characters

The regularExpression that will be used to match against column/field names or data values during the execution of a profile job.

dataLevelProfiling
boolean
Default: false

This field determines whether the profile expression will be targeted at the underlying data in a data source (e.g. row values in the database column / field values in the file), or whether the profile expression will be targeted at the schema of the data source (e.g. column names in a database table or field names in a file). Data-Level profiling consumes more memory than Column-Name-Level/Field-Name-Level profiling due to the fact that the profile expression must be checked against a larger number of data values (e.g. hundreds) than column/field names (i.e. one).

Responses
201

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

post/profile-expressions
Request samples
application/json
{
  • "domainName": "ADDRESS",
  • "expressionName": "Address - Specialized",
  • "regularExpression": "^special|regex?for*my.addresses",
  • "dataLevelProfiling": true
}
Response samples
application/json
{
  • "domainName": "ADDRESS",
  • "expressionName": "Address - Specialized",
  • "regularExpression": "^special|regex?for*my.addresses",
  • "dataLevelProfiling": true
}

Get profile expression by ID

Securityapi_key
Request
path Parameters
profileExpressionId
required
integer <int32>

The ID of the profile expression to get

Responses
200

Success

403

Forbidden access

404

Not found

get/profile-expressions/{profileExpressionId}
Response samples
application/json
{
  • "domainName": "ADDRESS",
  • "expressionName": "Address - Specialized",
  • "regularExpression": "^special|regex?for*my.addresses",
  • "dataLevelProfiling": true
}

Update profile expression by ID

Securityapi_key
Request
path Parameters
profileExpressionId
required
integer <int32>

The ID of the profile expression to update

Request Body schema: application/json
required

The updated profile expression

domainName
required
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.

expressionName
required
string <= 255 characters

The name of the profile expression; it must be unique.

regularExpression
required
string <= 1000 characters

The regularExpression that will be used to match against column/field names or data values during the execution of a profile job.

dataLevelProfiling
boolean
Default: false

This field determines whether the profile expression will be targeted at the underlying data in a data source (e.g. row values in the database column / field values in the file), or whether the profile expression will be targeted at the schema of the data source (e.g. column names in a database table or field names in a file). Data-Level profiling consumes more memory than Column-Name-Level/Field-Name-Level profiling due to the fact that the profile expression must be checked against a larger number of data values (e.g. hundreds) than column/field names (i.e. one).

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

put/profile-expressions/{profileExpressionId}
Request samples
application/json
{
  • "domainName": "ADDRESS",
  • "expressionName": "Address - Specialized",
  • "regularExpression": "^special|regex?for*my.addresses",
  • "dataLevelProfiling": true
}
Response samples
application/json
{
  • "domainName": "ADDRESS",
  • "expressionName": "Address - Specialized",
  • "regularExpression": "^special|regex?for*my.addresses",
  • "dataLevelProfiling": true
}

Delete profile expression by ID

Securityapi_key
Request
path Parameters
profileExpressionId
required
integer <int32>

The ID of the profile expression to delete

Responses
200

Success

403

Forbidden access

404

Not found

delete/profile-expressions/{profileExpressionId}

Search profile expressions

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

The page number for which to get profile expressions. 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: "profileExpressionId" "-profileExpressionId" "expressionName" "-expressionName" "colOrDataInd" "-colOrDataInd" "expressionType" "-expressionType" "domainName" "-domainName"
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: "profileExpressionId", "expressionName", "colOrDataInd", "expressionType", "domainName"

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

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