# Get all Mainframe Dataset metadata

Endpoint: GET /mainframe-dataset-metadata
Version: 5.1.51
Security: api_key

## Security:

  - `api_key` (unknown)
    apiKey in header Authorization

## Query parameters:

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

  - `page_number` (integer)
    The page number for which to get Mainframe Dataset 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

## Response default:

  - `default` (unknown)
    Successful operation

## Response default 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)

  - `responseList.mainframeDatasetMetadataId` (integer)
    The ID of the Mainframe Dataset metadata. This field is set by the Masking Engine.

  - `responseList.fileName` (string, required)
    The name of the Mainframe Dataset 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.

  - `responseList.rulesetId` (integer, required)
    The ID of the ruleset to create the Mainframe Dataset metadata on.

  - `responseList.mainframeDatasetFormatId` (integer)
    The ID of the Mainframe Dataset format corresponding to this Mainframe Dataset metadata. It is used to determine the fields for this file. This field is required.

  - `responseList.recordFormat` (string)
    The record format type for the mainframe data set. Note that this enum corresponds to the Variable Length checkbox in the UI.
    Enum: "FIXED_BLOCKED", "VARIABLE_BLOCKED"

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

