# Get all column metadata

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

## Query parameters:

  - `table_metadata_id` (integer)
    The ID of the table metadata to get all column metadata from

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

  - `page_number` (integer)
    The page number for which to get column 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","isProfilerWritable":false}]

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

  - `responseList.columnName` (string)
    The name of the column, as determined by the underlying table.

  - `responseList.tableMetadataId` (integer)
    The ID number of the table metadata that this column is a part of. This field is auto-generated by the Masking Engine.

  - `responseList.algorithmName` (string)
    The name of the algorithm assigned to this column. Columns 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 column. Columns 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.dataType` (string)
    The data type of this column.

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

  - `responseList.columnLength` (integer)
    The length of the column, in number of characters, as determined by the underlying table.

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

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

  - `responseList.isPrimaryKey` (boolean)
    This field indicates whether or not a column is a primary key. This field is determined by the Masking Engine.

  - `responseList.isIdentity` (boolean)
    This field indicates whether or not a column is an identity column. An identity column differs from a primary key in that its values are managed by the database server and usually cannot be modified. In many cases an identity column is used as a primary key; however, this is not always the case. This field is determined by the Masking Engine.

  - `responseList.isIndex` (boolean)
    This field indicates whether or not a column is an index. This field is determined by the Masking Engine.

  - `responseList.isForeignKey` (boolean)
    This field indicates whether or not a column is a foreign key. This field is determined by the Masking Engine.

  - `responseList.nullable` (string)
    This field indicates whether or not a column is nullable. This field is determined by the Masking Engine.

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

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

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

  - `responseList.domainAssignedBy` (string)
    This field indicates who assigned the domain to the column.


## Response 400 fields

## Response 403 fields

## Response 404 fields