tableMetadata

Get all table metadata

Securityapi_key
Request
query Parameters
ruleset_id
integer <int32>

The ID of the ruleset to get all table metadata from

page_number
integer <int64>
Default: 1

The page number for which to get table metadata. 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

is_masked
boolean

Get only masked table metadata when this is true, only unmasked column metadata when this is false and leaving this blank will get all tables

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

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

Create table metadata

Securityapi_key
Request
Request Body schema: application/json
required

The table metadata to create

tableName
required
string <= 255 characters

The name of the table metadata. This name must match the name of a table in the ruleset it is created on. This name must be unique for the given ruleset; in other words, the same table cannot be added to a ruleset more than once.

rulesetId
required
integer <int32>

The ID of the ruleset to create the table metadata on.

customSql
string

Custom SQL for the table.

whereClause
string <= 5000 characters

SQL where clause for the table.

havingClause
string <= 200 characters

SQL having clause for the table.

keyColumn
string <= 1024 characters

Key Column for the table.

Responses
201

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

post/table-metadata
Request samples
application/json
{
  • "tableName": "profile",
  • "rulesetId": 1
}
Response samples
application/json
{
  • "tableName": "profile",
  • "rulesetId": 1
}

Get table metadata by ID

Securityapi_key
Request
path Parameters
tableMetadataId
required
integer <int32>

The ID of the table metadata to get

Responses
200

Success

400

Bad request

404

Not found

get/table-metadata/{tableMetadataId}
Response samples
application/json
{
  • "tableName": "profile",
  • "rulesetId": 1
}

Update table metadata by ID

Securityapi_key
Request
path Parameters
tableMetadataId
required
integer <int32>

The ID of the table metadata to update

Request Body schema: application/json
required

Adding a filter to the table will remove the table's existing custom SQL, and vice versa.

tableName
required
string <= 255 characters

The name of the table metadata. This name must match the name of a table in the ruleset it is created on. This name must be unique for the given ruleset; in other words, the same table cannot be added to a ruleset more than once.

rulesetId
required
integer <int32>

The ID of the ruleset to create the table metadata on.

customSql
string

Custom SQL for the table.

whereClause
string <= 5000 characters

SQL where clause for the table.

havingClause
string <= 200 characters

SQL having clause for the table.

keyColumn
string <= 1024 characters

Key Column for the table.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

put/table-metadata/{tableMetadataId}
Request samples
application/json
{
  • "tableName": "profile",
  • "rulesetId": 1
}
Response samples
application/json
{
  • "tableName": "profile",
  • "rulesetId": 1
}

Delete table metadata by ID

Securityapi_key
Request
path Parameters
tableMetadataId
required
integer <int32>

The ID of the table metadata to delete

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

delete/table-metadata/{tableMetadataId}

Generate customSQL for table

Securityapi_key
Request
path Parameters
tableMetadataId
required
integer <int32>

The ID of the table for which customSQL has to be generated

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/table-metadata/{tableMetadataId}/generateCustomSQL
Response samples
application/json
{
  • "customSql": "SELECT FROM public table1"
}
➔ Next to tokenizationJob