# Get all file metadata

Endpoint: GET /file-metadata
Version: 5.1.47
Security: api_key

## Query parameters:

  - `page_number` (integer)
    The page number for which to get file metadata. This will default to the first page if excluded

  - `page_size` (integer)
    The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

  - `ruleset_id` (integer)
    The ID of the ruleset to get all file metadata from

## Response 200 fields (application/json):

  - `_pageInfo` (object)

  - `_pageInfo.numberOnPage` (integer)
    The number of items on this page. This should always match the page size unless it is the last page.

  - `_pageInfo.total` (integer)
    The total number of items

  - `responseList` (array)
    Example: [{"fileName":"file.delimited","rulesetId":1,"fileFormatId":2,"delimiter":"*","endOfRecord":"\n"}]

  - `responseList.fileMetadataId` (integer)
    The ID of the file metadata. This field is set by the Masking Engine.

  - `responseList.fileName` (string, required)
    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"

  - `responseList.rulesetId` (integer, required)
    The ID of the ruleset to create the file metadata on.
    Example: 1

  - `responseList.fileFormatId` (integer)
    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

  - `responseList.fileType` (string)
    The type of file this is. This field will match the file connector file type.
    Enum: "DELIMITED", "FIXED_WIDTH", "XML", "JSON", "PARQUET"

  - `responseList.delimiter` (string)
    The delimiter for a delimited file. This field should be left blank for other file types.
    Example: "*"

  - `responseList.enclosure` (string)
    The text enclosure for the file.

  - `responseList.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.

  - `responseList.escapeEnclosureEscapeCharacter` (boolean)
    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.

  - `responseList.endOfRecord` (string)
    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"

  - `responseList.nameIsRegularExpression` (boolean)
    Whether or not this file name represents a regular expression.

  - `responseList.wholeFileMasking` (boolean)
    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.


## Response 400 fields

## Response 403 fields

## Response 404 fields