Skip to content
/
Update table metadata by...

Masking API (5.1.41)

Schema for the Continuous Compliance Engine API

Download OpenAPI description
CC Engine APIs (2025.1.0.0).json
CC Engine APIs (2025.1.0.0).yaml
Languages
Servers
Mock server
https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0
https://help-api.delphix.com/masking/api/v5.1.41

algorithm

Operations

logging

Operations

application

Operations

applicationSettings

Operations

asyncTask

Operations

billingUsage

Operations

classifier

Operations

columnMetadata

Operations

credentialPath

Operations

configuration

Operations

databaseConnector

Operations

databaseRuleset

Operations

domain

Operations

encryptionKey

Operations

environment

Operations

execution

Operations

executionComponent

Operations

executionEvent

Operations

sync

Operations

fileConnector

Operations

fileDownload

Operations

fileFieldMetadata

Operations

fileFormat

Operations

fileMetadata

Operations

fileRuleset

Operations

fileUpload

Operations

inventoryApproval

Operations

knowledgeBaseInfo

Operations

jdbcDriver

Operations

license

Operations

login

Operations

mainframeDatasetConnector

Operations

mainframeDatasetFieldMetadata

Operations

mainframeDatasetFormat

Operations

mainframeDatasetMetadata

Operations

mainframeDatasetRecordType

Operations

mainframeDatasetRuleset

Operations

mappingAlgorithm

Operations

maskingJob

Operations

monitoring

Operations

mountFilesystem

Operations

nonConformantDataSample

Operations

passwordVault

Operations

plugin

Operations

profileJob

Operations

profileSet

Operations

profileResultDatabase

Operations

profileResultFile

Operations

profileResultMainframe

Operations

recordType

Operations

recordTypeQualifier

Operations

reidentificationJob

Operations

role

Operations

sshKey

Operations

supportBundle

Operations

systemInformation

Operations

tableMetadata

Operations

Get all table metadata

Request

Security
api_key
Query
ruleset_idinteger(int32)

The ID of the ruleset to get all table metadata from

page_numberinteger(int64)

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

Default 1
page_sizeinteger(int64)

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

is_maskedboolean

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

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/table-metadata?ruleset_id=0&page_number=1&page_size=0&is_masked=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(TableMetadata)
Example: [{"tableName":"profile","rulesetId":1}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create table metadata

Request

Security
api_key
Bodyapplication/jsonrequired

The table metadata to create

tableNamestring<= 255 charactersrequired

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.

Example: "profile"
rulesetIdinteger(int32)required

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

Example: 1
customSqlstring

Custom SQL for the table.

whereClausestring<= 5000 characters

SQL where clause for the table.

havingClausestring<= 200 characters

SQL having clause for the table.

keyColumnstring<= 1024 characters

Key Column for the table.

curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/table-metadata \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "tableName": "profile",
    "rulesetId": 1
  }'

Responses

Success

Bodyapplication/json
tableMetadataIdinteger(int32)read-only

The ID of the table metadata. This field is set by the Masking Engine.

tableNamestring<= 255 charactersrequired

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.

Example: "profile"
rulesetIdinteger(int32)required

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

Example: 1
customSqlstring

Custom SQL for the table.

whereClausestring<= 5000 characters

SQL where clause for the table.

havingClausestring<= 200 characters

SQL having clause for the table.

keyColumnstring<= 1024 characters

Key Column for the table.

isMaskedbooleanread-only

This field is true if one or more data columns associated with this table have a masking assignment, and false otherwise. Results may be filtered by this field using the search API.

rowCountinteger(int64)read-only

The last known row count of the table. This value is updated during rule set refresh and when a masking job is executed.

lastRefreshTimestring(date-time)read-only

The last time the table and column metadata for this rule set were refreshed.

lastRowCountTimestring(date-time)read-only

The last time table row counts for this rule set were fully refreshed.

Response
application/json
{
  "tableName": "profile",
  "rulesetId": 1
}

Get table metadata by ID

Request

Security
api_key
Path
tableMetadataIdinteger(int32)required

The ID of the table metadata to get

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/table-metadata/{tableMetadataId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
tableMetadataIdinteger(int32)read-only

The ID of the table metadata. This field is set by the Masking Engine.

tableNamestring<= 255 charactersrequired

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.

Example: "profile"
rulesetIdinteger(int32)required

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

Example: 1
customSqlstring

Custom SQL for the table.

whereClausestring<= 5000 characters

SQL where clause for the table.

havingClausestring<= 200 characters

SQL having clause for the table.

keyColumnstring<= 1024 characters

Key Column for the table.

isMaskedbooleanread-only

This field is true if one or more data columns associated with this table have a masking assignment, and false otherwise. Results may be filtered by this field using the search API.

rowCountinteger(int64)read-only

The last known row count of the table. This value is updated during rule set refresh and when a masking job is executed.

lastRefreshTimestring(date-time)read-only

The last time the table and column metadata for this rule set were refreshed.

lastRowCountTimestring(date-time)read-only

The last time table row counts for this rule set were fully refreshed.

Response
application/json
{
  "tableName": "profile",
  "rulesetId": 1
}

Update table metadata by ID

Request

Security
api_key
Path
tableMetadataIdinteger(int32)required

The ID of the table metadata to update

Bodyapplication/jsonrequired

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

tableNamestring<= 255 charactersrequired

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.

Example: "profile"
rulesetIdinteger(int32)required

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

Example: 1
customSqlstring

Custom SQL for the table.

whereClausestring<= 5000 characters

SQL where clause for the table.

havingClausestring<= 200 characters

SQL having clause for the table.

keyColumnstring<= 1024 characters

Key Column for the table.

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/table-metadata/{tableMetadataId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "tableName": "profile",
    "rulesetId": 1
  }'

Responses

Success

Bodyapplication/json
tableMetadataIdinteger(int32)read-only

The ID of the table metadata. This field is set by the Masking Engine.

tableNamestring<= 255 charactersrequired

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.

Example: "profile"
rulesetIdinteger(int32)required

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

Example: 1
customSqlstring

Custom SQL for the table.

whereClausestring<= 5000 characters

SQL where clause for the table.

havingClausestring<= 200 characters

SQL having clause for the table.

keyColumnstring<= 1024 characters

Key Column for the table.

isMaskedbooleanread-only

This field is true if one or more data columns associated with this table have a masking assignment, and false otherwise. Results may be filtered by this field using the search API.

rowCountinteger(int64)read-only

The last known row count of the table. This value is updated during rule set refresh and when a masking job is executed.

lastRefreshTimestring(date-time)read-only

The last time the table and column metadata for this rule set were refreshed.

lastRowCountTimestring(date-time)read-only

The last time table row counts for this rule set were fully refreshed.

Response
application/json
{
  "tableName": "profile",
  "rulesetId": 1
}

Delete table metadata by ID

Request

Security
api_key
Path
tableMetadataIdinteger(int32)required

The ID of the table metadata to delete

curl -i -X DELETE \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/table-metadata/{tableMetadataId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Generate customSQL for table

Request

Security
api_key
Path
tableMetadataIdinteger(int32)required

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

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/table-metadata/{tableMetadataId}/generateCustomSQL' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
customSqlstring

Custom SQL for the table.

Example: "SELECT FROM public table1"
Response
application/json
{
  "customSql": "SELECT FROM public table1"
}

tokenizationJob

Operations

user

Operations