Get file field metadata by ID

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

Get all file field metadata

Request

Security

api_key

Query

file_format_idinteger(int32)

The ID of the file format to get all file field metadata from

record_type_idinteger(int32)

The ID of the record type to get all file field metadata from

field_namestring

The name of the file field, as determined by the associated file format. A wildcard character '*' can be used to represent zero or more characters. To match exact character '*' or '' in the fieldName, escape the character using '' like '\*' and '\\' respectively.

is_maskedboolean

Get only masked file field metadata when this is true and only unmasked file field metadata when this is false

page_numberinteger(int64)

The page number for which to get file field 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.2.0.0/cc-engine-apis-2025.2.0.0/file-field-metadata?file_format_id=0&record_type_id=0&field_name=string&is_masked=true&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

_pageInfoobject(PageInfo)

responseListArray of objects(FileFieldMetadata)

Example: [{"recordTypeId":1,"fieldName":"FooField","fieldPositionNumber":6,"fieldLength":10,"algorithmName":"FirstNameLookup","domainName":"FIRST_NAME","isProfilerWritable":false}]

Response

application/json

{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create file field metadata

Request

Security

api_key

Bodyapplication/jsonrequired

The file filed metadata to create

recordTypeIdinteger(int32)

The ID number of the record type that defines this file field. Required in case of Create API

Example: 1

fieldLengthinteger(int32)

The length of the file field, in number of characters, as determined by the associated file format. Required in case of Create API

Example: 10

fieldPositionNumberinteger(int32)

The position of the file field with respect to the other file fields, as determined by the associated file format. Required in case of Create API

Example: 6

algorithmNamestring<= 500 characters

The name of the algorithm assigned to this file field. File fields 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<= 20 characters

The name of the domain assigned to this file field. File fields 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 file filed's algorithm or domain assignment may be modified during the execution of a profile job when there is a profiling match.

notesstring<= 500 characters

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

documentStoreTypestring

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

docStoreFileFormatIdinteger(int32)

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

curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/file-field-metadata \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "recordTypeId": 1,
    "fieldName": "FooField",
    "fieldPositionNumber": 6,
    "fieldLength": 10,
    "algorithmName": "FirstNameLookup",
    "domainName": "FIRST_NAME",
    "isProfilerWritable": false
  }'

Responses

Success

Bodyapplication/json

fileFieldMetadataIdinteger(int32)read-only

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

fileFormatIdinteger(int32)read-only

The ID number of the file format that defines this file field.

recordTypeIdinteger(int32)

The ID number of the record type that defines this file field. Required in case of Create API

Example: 1

fieldLengthinteger(int32)

The length of the file field, in number of characters, as determined by the associated file format. Required in case of Create API

Example: 10

fieldNamestringread-only

The name of the file field, as determined by the associated file format. Required in case of Create API

Example: "FooField"

fieldPositionNumberinteger(int32)

The position of the file field with respect to the other file fields, as determined by the associated file format. Required in case of Create API

Example: 6

algorithmNamestring<= 500 characters

The name of the algorithm assigned to this file field. File fields 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.

algorithmFieldNamestringread-only

The name 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<= 20 characters

The name of the domain assigned to this file field. File fields 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.

isMaskedbooleanread-only

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

isProfilerWritablebooleanrequired

This field indicates whether or not a file filed's algorithm or domain assignment may be modified during the execution of a profile job when there is a profiling match.

notesstring<= 500 characters

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

documentStoreTypestring

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

docStoreFileFormatIdinteger(int32)

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

docStoreFileFormatNamestringread-only

The name of the document store file format. Required in case where documentStoreType is assigned.

Response

application/json

{
  "recordTypeId": 1,
  "fieldName": "FooField",
  "fieldPositionNumber": 6,
  "fieldLength": 10,
  "algorithmName": "FirstNameLookup",
  "domainName": "FIRST_NAME",
  "isProfilerWritable": false
}