Get file 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

fileFormat

Operations

fileMetadata

Operations

Get all file metadata

Request

Security

api_key

Query

page_numberinteger(int64)

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

ruleset_idinteger(int32)

The ID of the ruleset to get all file metadata from

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-metadata?page_number=1&page_size=0&ruleset_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

_pageInfoobject(PageInfo)

responseListArray of objects(FileMetadata)

Example: [{"fileName":"file.delimited","rulesetId":1,"fileFormatId":2,"delimiter":"*","endOfRecord":"\n"}]

Response

application/json

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

Create file metadata

Request

Security

api_key

Bodyapplication/jsonrequired

The file metadata to create

rulesetIdinteger(int32)required

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

Example: 1

fileFormatIdinteger(int32)

The ID of the file format corresponding to this file. It is used to determine the fields for this file. This field is required.

Example: 2

delimiterstring<= 50 characters

The delimiter for a delimited file. This field should be left blank for other file types.

Example: "*"

enclosurestring<= 5 characters

The text enclosure for the file.

enclosureEscapeCharacterstring

The character used to escape a literal enclosure character within an enclosed value. By default, this is equal to the enclosure value itself, so doubling the enclosure character escape it.

escapeEnclosureEscapeCharacterboolean

This flag indicates whether the enclosure escape character also escapes itself. For example, if the enclosure escape character is *, then the sequence ** would be treated as a single * character, rather than an escape.

Default false

endOfRecordstring<= 25 characters

The string of characters that delineates the end-of-record for a file. Note that, for linux this is '\n', and for windows it is '\r\n'.

Example: "\n"

nameIsRegularExpressionboolean

Whether or not this file name represents a regular expression.

Default false

wholeFileMaskingboolean

This flag indicates whether the file is 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.

Default false

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-metadata \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "fileName": "file.delimited",
    "rulesetId": 1,
    "fileFormatId": 2,
    "delimiter": "*",
    "endOfRecord": "\n"
  }'

Responses

Success

Bodyapplication/json

fileMetadataIdinteger(int32)read-only

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

fileNamestring<= 255 charactersread-onlyrequired

The name of the file metadata. This name must match the name of a file in the ruleset it is created on. This name must be unique for the given ruleset; in other words, the same file cannot be added to a ruleset more than once.

Example: "file.delimited"

rulesetIdinteger(int32)required

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

Example: 1

fileFormatIdinteger(int32)

The ID of the file format corresponding to this file. It is used to determine the fields for this file. This field is required.

Example: 2

fileTypestringread-only

The type of file this is. This field will match the file connector file type.

Enum"DELIMITED""FIXED_WIDTH""XML""JSON""PARQUET"

delimiterstring<= 50 characters

The delimiter for a delimited file. This field should be left blank for other file types.

Example: "*"

enclosurestring<= 5 characters

The text enclosure for the file.

enclosureEscapeCharacterstring

The character used to escape a literal enclosure character within an enclosed value. By default, this is equal to the enclosure value itself, so doubling the enclosure character escape it.

escapeEnclosureEscapeCharacterboolean

This flag indicates whether the enclosure escape character also escapes itself. For example, if the enclosure escape character is *, then the sequence ** would be treated as a single * character, rather than an escape.

Default false

endOfRecordstring<= 25 characters

The string of characters that delineates the end-of-record for a file. Note that, for linux this is '\n', and for windows it is '\r\n'.

Example: "\n"

nameIsRegularExpressionboolean

Whether or not this file name represents a regular expression.

Default false

wholeFileMaskingboolean

This flag indicates whether the file is 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.

Default false

Response

application/json

{
  "fileName": "file.delimited",
  "rulesetId": 1,
  "fileFormatId": 2,
  "delimiter": "*",
  "endOfRecord": "\n"
}