Skip to content
/
Get file format by ID

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/2026.5.0.0/cc-engine-apis-2026.5.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.

fileFormatDownloadIdstringread-only

The ID of the file format download. This is used to download the file format.

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