Skip to content
/
Get all column metadata

Masking API (5.1.43)

Schema for the Continuous Compliance Engine API

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

algorithm

Operations

logging

Operations

application

Operations

applicationSettings

Operations

asyncTask

Operations

billingUsage

Operations

classifier

Operations

columnMetadata

Operations

Get all column metadata

Request

Security
api_key
Query
table_metadata_idinteger(int32)

The ID of the table metadata to get all column metadata from

is_maskedboolean

Get only masked column metadata when this is true and only unmasked column metadata when this is false

page_numberinteger(int64)

The page number for which to get column 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

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

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(ColumnMetadata)
Example: [{"algorithmName":"FirstNameLookup","domainName":"FIRST_NAME","isProfilerWritable":false}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Get column metadata by ID

Request

Security
api_key
Path
columnMetadataIdinteger(int64)required

The ID of the column metadata to get

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

Responses

Success

Bodyapplication/json
columnMetadataIdinteger(int64)read-only

The ID number of the column metadata. This field is auto-generated by the Masking Engine.

columnNamestring<= 255 charactersread-only

The name of the column, as determined by the underlying table.

tableMetadataIdinteger(int32)read-only

The ID number of the table metadata that this column is a part of. This field is auto-generated by the Masking Engine.

algorithmNamestring<= 500 characters

The name of the algorithm assigned to this column. Columns that are unmasked should have this property unset, in addition to having 'domainName' unset. If this field is set, then the 'domainName' must also be specified.

Example: "FirstNameLookup"
algorithmFieldIdinteger(int64)

The ID number of the algorithm field that is associated with this column.

algorithmGroupNointeger(int64)

The group number of algorithm to identify a set of columns associated with one instance of algorithm.

domainNamestring<= 100 characters

The name of the domain assigned to this column. Columns that are left unmasked should have this property unset. If the 'domainName' is set, but the 'algorithmName' is unset, then the default algorithm corresponding to the 'domainName' will be used.

Example: "FIRST_NAME"
dataTypestring<= 50 charactersread-only

The data type of this column.

dateFormatstring<= 50 characters

The date format of the date assigned to this column.

columnLengthinteger(int32)read-only

The length of the column, in number of characters, as determined by the underlying table.

isMaskedbooleanread-only

This field indicates whether or not a column is being masked. This field is assigned by the Masking Engine to true or false based on whether the column is assigned an algorithm and domain.

isProfilerWritablebooleanrequired

This field indicates whether or not a column's fields (e.g. algorithm or domain assignment) may be modified during the execution of a profile job when there is a profiling match.

isPrimaryKeybooleanread-only

This field indicates whether or not a column is a primary key. This field is determined by the Masking Engine.

isIdentitybooleanread-only

This field indicates whether or not a column is an identity column. An identity column differs from a primary key in that its values are managed by the database server and usually cannot be modified. In many cases an identity column is used as a primary key; however, this is not always the case. This field is determined by the Masking Engine.

isIndexbooleanread-only

This field indicates whether or not a column is an index. This field is determined by the Masking Engine.

isForeignKeybooleanread-only

This field indicates whether or not a column is a foreign key. This field is determined by the Masking Engine.

documentStoreTypestring

This field indicates the type of document stored in the column. Required in case where fileFormatId is provided. Accepted values: ['JSON','XML']

fileFormatIdinteger(int32)

The ID number of the file format. Required in case where documentStoreType is provided.

notesstring<= 500 characters

This field is used to store additional information about the column.

domainAssignedBystringread-only

This field indicates who assigned the domain to the column.

Response
application/json
{
  "algorithmName": "FirstNameLookup",
  "domainName": "FIRST_NAME",
  "isProfilerWritable": false
}

Update column metadata by ID

Request

Security
api_key
Path
columnMetadataIdinteger(int64)required

The ID of the column metadata to update

Bodyapplication/jsonrequired

The updated column metadata

algorithmNamestring<= 500 characters

The name of the algorithm assigned to this column. Columns that are unmasked should have this property unset, in addition to having 'domainName' unset. If this field is set, then the 'domainName' must also be specified.

Example: "FirstNameLookup"
algorithmFieldIdinteger(int64)

The ID number of the algorithm field that is associated with this column.

algorithmGroupNointeger(int64)

The group number of algorithm to identify a set of columns associated with one instance of algorithm.

domainNamestring<= 100 characters

The name of the domain assigned to this column. Columns that are left unmasked should have this property unset. If the 'domainName' is set, but the 'algorithmName' is unset, then the default algorithm corresponding to the 'domainName' will be used.

Example: "FIRST_NAME"
dateFormatstring<= 50 characters

The date format of the date assigned to this column.

isProfilerWritablebooleanrequired

This field indicates whether or not a column's fields (e.g. algorithm or domain assignment) may be modified during the execution of a profile job when there is a profiling match.

documentStoreTypestring

This field indicates the type of document stored in the column. Required in case where fileFormatId is provided. Accepted values: ['JSON','XML']

fileFormatIdinteger(int32)

The ID number of the file format. Required in case where documentStoreType is provided.

notesstring<= 500 characters

This field is used to store additional information about the column.

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/column-metadata/{columnMetadataId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "algorithmName": "FirstNameLookup",
    "domainName": "FIRST_NAME",
    "isProfilerWritable": false
  }'

Responses

Success

Bodyapplication/json
columnMetadataIdinteger(int64)read-only

The ID number of the column metadata. This field is auto-generated by the Masking Engine.

columnNamestring<= 255 charactersread-only

The name of the column, as determined by the underlying table.

tableMetadataIdinteger(int32)read-only

The ID number of the table metadata that this column is a part of. This field is auto-generated by the Masking Engine.

algorithmNamestring<= 500 characters

The name of the algorithm assigned to this column. Columns that are unmasked should have this property unset, in addition to having 'domainName' unset. If this field is set, then the 'domainName' must also be specified.

Example: "FirstNameLookup"
algorithmFieldIdinteger(int64)

The ID number of the algorithm field that is associated with this column.

algorithmGroupNointeger(int64)

The group number of algorithm to identify a set of columns associated with one instance of algorithm.

domainNamestring<= 100 characters

The name of the domain assigned to this column. Columns that are left unmasked should have this property unset. If the 'domainName' is set, but the 'algorithmName' is unset, then the default algorithm corresponding to the 'domainName' will be used.

Example: "FIRST_NAME"
dataTypestring<= 50 charactersread-only

The data type of this column.

dateFormatstring<= 50 characters

The date format of the date assigned to this column.

columnLengthinteger(int32)read-only

The length of the column, in number of characters, as determined by the underlying table.

isMaskedbooleanread-only

This field indicates whether or not a column is being masked. This field is assigned by the Masking Engine to true or false based on whether the column is assigned an algorithm and domain.

isProfilerWritablebooleanrequired

This field indicates whether or not a column's fields (e.g. algorithm or domain assignment) may be modified during the execution of a profile job when there is a profiling match.

isPrimaryKeybooleanread-only

This field indicates whether or not a column is a primary key. This field is determined by the Masking Engine.

isIdentitybooleanread-only

This field indicates whether or not a column is an identity column. An identity column differs from a primary key in that its values are managed by the database server and usually cannot be modified. In many cases an identity column is used as a primary key; however, this is not always the case. This field is determined by the Masking Engine.

isIndexbooleanread-only

This field indicates whether or not a column is an index. This field is determined by the Masking Engine.

isForeignKeybooleanread-only

This field indicates whether or not a column is a foreign key. This field is determined by the Masking Engine.

documentStoreTypestring

This field indicates the type of document stored in the column. Required in case where fileFormatId is provided. Accepted values: ['JSON','XML']

fileFormatIdinteger(int32)

The ID number of the file format. Required in case where documentStoreType is provided.

notesstring<= 500 characters

This field is used to store additional information about the column.

domainAssignedBystringread-only

This field indicates who assigned the domain to the column.

Response
application/json
{
  "algorithmName": "FirstNameLookup",
  "domainName": "FIRST_NAME",
  "isProfilerWritable": false
}

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

tokenizationJob

Operations

user

Operations