# Get all Mainframe Dataset field metadata

Endpoint: GET /mainframe-dataset-field-metadata
Version: 5.1.42
Security: api_key

## Query parameters:

  - `mainframe_dataset_format_id` (integer)
    The ID of the Mainframe Dataset format to get all Mainframe Dataset field metadata from

  - `is_masked` (boolean)
    Get only masked Mainframe Dataset field metadata when this is true and only unmasked Mainframe Dataset field metadata when this is false

  - `page_number` (integer)
    The page number for which to get Mainframe Dataset field 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 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: [{"algorithmName":"FirstNameLookup","domainName":"FIRST_NAME"}]

  - `responseList.mainframeDatasetFieldMetadataId` (integer)
    The ID number of the Mainframe Dataset field metadata. This field is auto-generated by the Masking Engine.

  - `responseList.mainframeDatasetFormatId` (integer)
    The ID number of the Mainframe Dataset format that defines this Mainframe Dataset field.

  - `responseList.fieldName` (string)
    The name of the Mainframe Dataset field, as determined by the associated Mainframe Dataset format.

  - `responseList.algorithmName` (string)
    The name of the algorithm assigned to this Mainframe Dataset field. Mainframe Dataset fields that are unmasked should have this property unset, in addition to having 'domainName' unset. If this field is set, then the 'domainName' must also be specified.
    Example: "FirstNameLookup"

  - `responseList.algorithmFieldId` (integer)
    The ID number of the algorithm field that is associated with this column.

  - `responseList.algorithmGroupNo` (integer)
    The group number of algorithm to identify a set of columns associated with one instance of algorithm.

  - `responseList.domainName` (string)
    The name of the domain assigned to this Mainframe Dataset field. Mainframe Dataset fields that are left unmasked should have this property unset. If the 'domainName' is set, but the 'algorithmName' is unset, then the default algorithm corresponding to the 'domainName' will be used.
    Example: "FIRST_NAME"

  - `responseList.dateFormat` (string)
    The date format of the date assigned to this Mainframe Dataset field.

  - `responseList.isMasked` (boolean)
    This field indicates whether or not a Mainframe Dataset field is being masked. This field is assigned by the Masking Engine to true or false based on whether the Mainframe Dataset field is assigned an algorithm and domain.

  - `responseList.isProfilerWritable` (boolean)
    This field indicates whether or not a Mainframe Dataset field (e.g. algorithm or domain assignment) may be modified during the execution of a profile job when there is a profiling match.

  - `responseList.parentId` (integer)
    The ID number of the parent field of Mainframe Dataset field.


## Response 400 fields

## Response 403 fields

## Response 404 fields