# Get file field metadata by ID

Endpoint: GET /file-field-metadata/{fileFieldMetadataId}
Version: 5.1.45
Security: api_key

## Path parameters:

  - `fileFieldMetadataId` (integer, required)
    The ID of the file field metadata to get

## Response 200 fields (application/json):

  - `fileFieldMetadataId` (integer)
    The ID number of the file field metadata. This field is auto-generated by the Masking Engine.

  - `fileFormatId` (integer)
    The ID number of the file format that defines this file field.

  - `recordTypeId` (integer)
    The ID number of the record type that defines this file field. Required in case of Create API
    Example: 1

  - `fieldLength` (integer)
    The length of the file field, in number of characters, as determined by the associated file format. Required in case of Create API
    Example: 10

  - `fieldName` (string)
    The name of the file field, as determined by the associated file format. Required in case of Create API
    Example: "FooField"

  - `fieldPositionNumber` (integer)
    The position of the file field with respect to the other file fields, as determined by the associated file format. Required in case of Create API
    Example: 6

  - `algorithmName` (string)
    The name of the algorithm assigned to this file field. File 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"

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

  - `algorithmFieldName` (string)
    The name of the algorithm field that is associated with this column.

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

  - `domainName` (string)
    The name of the domain assigned to this file field. File 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"

  - `dateFormat` (string)
    The date format of the date assigned to this column.

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

  - `isProfilerWritable` (boolean, required)
    This field indicates whether or not a file filed's algorithm or domain assignment may be modified during the execution of a profile job when there is a profiling match.

  - `notes` (string)
    This field is used to store additional information about the file field.

  - `documentStoreType` (string)
    This field indicates the type of document stored in the file field. Required in case where docStoreFileFormatId is provided. Accepted values: ['JSON','XML']

  - `docStoreFileFormatId` (integer)
    The ID number of the document store file format. Required in case where documentStoreType is provided.

  - `docStoreFileFormatName` (string)
    The name of the document store file format. Required in case where documentStoreType is assigned.


## Response 400 fields

## Response 403 fields

## Response 404 fields