Skip to content
/
Create file format

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

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

Get all file formats

Request

Security
api_key
Query
page_numberinteger(int64)

The page number for which to get file formats. 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 property 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/file-formats?page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(FileFormat)
Example: [{"fileFormatId":"3","fileFormatName":"DelimitedFileFormat.txt","fileFormatType":"DELIMITED","header":2,"footer":1}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create file format

Request

WARNING: The generated curl command is incorrect, so please refer to the Masking API guide for instructions on how to upload files through the API

Security
api_key
Bodymultipart/form-datarequired
fileFormatstring(binary)required

The file format to be uploaded. The logical name of the file format will be exactly the name of this uploaded file

fileFormatTypestringrequired

The type of the file format being uploaded

Enum"DELIMITED""FIXED_WIDTH""XML""JSON""PARQUET"
curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/file-formats \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: multipart/form-data' \
  -F fileFormat=string \
  -F fileFormatType=DELIMITED

Responses

Success

Bodyapplication/json
fileFormatIdinteger(int32)read-only

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

Example: "3"
fileFormatNamestring<= 100 charactersread-only

The name of the file format, as inferred from the uploaded file.

Example: "DelimitedFileFormat.txt"
fileFormatTypestringread-only

The type of file that this file format describes.

Enum"DELIMITED""FIXED_WIDTH""XML""JSON""PARQUET"
Example: "DELIMITED"
headerinteger(int32)

The number of lines at the beginning of the file to skip.

Example: 2
footerinteger(int32)

The number of lines at the end of the file to skip.

Example: 1
wholeFileMaskingbooleanread-only

This flag indicates if the file format is associated with a file to be read as whole or line-by-line (Only for FIXED_WIDTH file type). For example, if the whole file masking is true, then the whole file will be read as a single record, rather than reading it line by line.

fieldsCountinteger(int64)read-only

This returns the number of fields present in a file format.

Response
application/json
{
  "fileFormatId": "3",
  "fileFormatName": "DelimitedFileFormat.txt",
  "fileFormatType": "DELIMITED",
  "header": 2,
  "footer": 1
}

Get file format by ID

Request

Security
api_key
Path
fileFormatIdinteger(int32)required

The ID of the file format 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/file-formats/{fileFormatId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
fileFormatIdinteger(int32)read-only

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

Example: "3"
fileFormatNamestring<= 100 charactersread-only

The name of the file format, as inferred from the uploaded file.

Example: "DelimitedFileFormat.txt"
fileFormatTypestringread-only

The type of file that this file format describes.

Enum"DELIMITED""FIXED_WIDTH""XML""JSON""PARQUET"
Example: "DELIMITED"
headerinteger(int32)

The number of lines at the beginning of the file to skip.

Example: 2
footerinteger(int32)

The number of lines at the end of the file to skip.

Example: 1
wholeFileMaskingbooleanread-only

This flag indicates if the file format is associated with a file to be read as whole or line-by-line (Only for FIXED_WIDTH file type). For example, if the whole file masking is true, then the whole file will be read as a single record, rather than reading it line by line.

fieldsCountinteger(int64)read-only

This returns the number of fields present in a file format.

Response
application/json
{
  "fileFormatId": "3",
  "fileFormatName": "DelimitedFileFormat.txt",
  "fileFormatType": "DELIMITED",
  "header": 2,
  "footer": 1
}

Update file format

Request

Security
api_key
Path
fileFormatIdinteger(int32)required

The ID of the file format to update

Bodyapplication/jsonrequired

The updated file format

headerinteger(int32)

The number of lines at the beginning of the file to skip.

Example: 2
footerinteger(int32)

The number of lines at the end of the file to skip.

Example: 1
curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/file-formats/{fileFormatId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "fileFormatId": "3",
    "fileFormatName": "DelimitedFileFormat.txt",
    "fileFormatType": "DELIMITED",
    "header": 2,
    "footer": 1
  }'

Responses

Success

Bodyapplication/json
fileFormatIdinteger(int32)read-only

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

Example: "3"
fileFormatNamestring<= 100 charactersread-only

The name of the file format, as inferred from the uploaded file.

Example: "DelimitedFileFormat.txt"
fileFormatTypestringread-only

The type of file that this file format describes.

Enum"DELIMITED""FIXED_WIDTH""XML""JSON""PARQUET"
Example: "DELIMITED"
headerinteger(int32)

The number of lines at the beginning of the file to skip.

Example: 2
footerinteger(int32)

The number of lines at the end of the file to skip.

Example: 1
wholeFileMaskingbooleanread-only

This flag indicates if the file format is associated with a file to be read as whole or line-by-line (Only for FIXED_WIDTH file type). For example, if the whole file masking is true, then the whole file will be read as a single record, rather than reading it line by line.

fieldsCountinteger(int64)read-only

This returns the number of fields present in a file format.

Response
application/json
{
  "fileFormatId": "3",
  "fileFormatName": "DelimitedFileFormat.txt",
  "fileFormatType": "DELIMITED",
  "header": 2,
  "footer": 1
}

Delete file format by ID

Request

Security
api_key
Path
fileFormatIdinteger(int32)required

The ID of the file format to delete

curl -i -X DELETE \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/file-formats/{fileFormatId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

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