fileMetadata

Get all file metadata

Securityapi_key
Request
query Parameters
page_number
integer <int64>
Default: 1

The page number for which to get file metadata. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

ruleset_id
integer <int32>

The ID of the ruleset to get all file metadata from

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/file-metadata
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create file metadata

Securityapi_key
Request
Request Body schema: application/json
required

The file metadata to create

rulesetId
required
integer <int32>

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

fileFormatId
integer <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.

delimiter
string <= 50 characters

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

enclosure
string <= 5 characters

The text enclosure for the file.

enclosureEscapeCharacter
string

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.

escapeEnclosureEscapeCharacter
boolean
Default: false

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.

endOfRecord
string <= 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'.

nameIsRegularExpression
boolean
Default: false

Whether or not this file name represents a regular expression.

wholeFileMasking
boolean
Default: false

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.

Responses
201

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

post/file-metadata
Request samples
application/json
{
  • "fileName": "file.delimited",
  • "rulesetId": 1,
  • "fileFormatId": 2,
  • "delimiter": "*",
  • "endOfRecord": "\n"
}
Response samples
application/json
{
  • "fileName": "file.delimited",
  • "rulesetId": 1,
  • "fileFormatId": 2,
  • "delimiter": "*",
  • "endOfRecord": "\n"
}

Get file metadata by ID

Securityapi_key
Request
path Parameters
fileMetadataId
required
integer <int32>

The ID of the file metadata to get

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/file-metadata/{fileMetadataId}
Response samples
application/json
{
  • "fileName": "file.delimited",
  • "rulesetId": 1,
  • "fileFormatId": 2,
  • "delimiter": "*",
  • "endOfRecord": "\n"
}

Update file metadata by ID

Securityapi_key
Request
path Parameters
fileMetadataId
required
integer <int32>

The ID of the file metadata to update

Request Body schema: application/json
required

Updated fileMetadata object

rulesetId
required
integer <int32>

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

fileFormatId
integer <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.

delimiter
string <= 50 characters

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

enclosure
string <= 5 characters

The text enclosure for the file.

enclosureEscapeCharacter
string

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.

escapeEnclosureEscapeCharacter
boolean
Default: false

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.

endOfRecord
string <= 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'.

nameIsRegularExpression
boolean
Default: false

Whether or not this file name represents a regular expression.

wholeFileMasking
boolean
Default: false

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.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

put/file-metadata/{fileMetadataId}
Request samples
application/json
{
  • "fileName": "file.delimited",
  • "rulesetId": 1,
  • "fileFormatId": 2,
  • "delimiter": "*",
  • "endOfRecord": "\n"
}
Response samples
application/json
{
  • "fileName": "file.delimited",
  • "rulesetId": 1,
  • "fileFormatId": 2,
  • "delimiter": "*",
  • "endOfRecord": "\n"
}

Delete file metadata by ID

Securityapi_key
Request
path Parameters
fileMetadataId
required
integer <int32>

The ID of the file metadata to delete

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

delete/file-metadata/{fileMetadataId}
➔ Next to fileRuleset