# Get all algorithm frameworks

Endpoint: GET /algorithm/frameworks
Version: 5.1.45
Security: api_key

## Query parameters:

  - `mask_type` (string)
    Return only frameworks that mask the specified data type.
    Enum: "BIG_DECIMAL", "LOCAL_DATE_TIME", "STRING", "BYTE_BUFFER", "GENERIC_DATA_ROW"

  - `include_schema` (boolean)
    Whether to include each algorithm framework's JSON schema in the response.

  - `page_number` (integer)
    The page number for which to get algorithm frameworks. 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: [{"frameworkId":1,"frameworkName":"MinMax","frameworkType":"STRING","plugin":{"pluginId":1,"pluginName":"myPlugin","pluginAuthor":"pluginAuthor"}}]

  - `responseList.frameworkId` (integer)
    The id of the algorithm framework installed using Plugin API.
    Example: 1

  - `responseList.frameworkName` (string)
    The name of the algorithm framework installed using Plugin API.
    Example: "MinMax"

  - `responseList.frameworkType` (string)
    The type of value this algorithm framework masks.
    Enum: "BIG_DECIMAL", "LOCAL_DATE_TIME", "STRING", "BYTE_BUFFER", "GENERIC_DATA_ROW", "ADVANCED_OBJECT"

  - `responseList.description` (string)
    The description of the algorithm framework

  - `responseList.plugin` (object)
    Example: {"pluginId":1,"pluginName":"myPlugin","pluginAuthor":"pluginAuthor","pluginType":"EXTENDED_ALGORITHM"}

  - `responseList.plugin.pluginId` (integer)
    The id of the plugin
    Example: 1

  - `responseList.plugin.pluginName` (string)
    The name of the plugin
    Example: "myPlugin"

  - `responseList.plugin.pluginAuthor` (string)
    The author of the plugin
    Example: "pluginAuthor"

  - `responseList.plugin.pluginType` (string)
    The type of plugin
    Enum: "EXTENDED_ALGORITHM", "DRIVER_SUPPORT"

  - `responseList.fields` (array)

  - `responseList.fields.fieldId` (integer)
    The id of the algorithm field.

  - `responseList.fields.name` (string)
    The name of the algorithm field.

  - `responseList.fields.type` (string)
    The type of value this algorithm field.
    Enum: "BIG_DECIMAL", "LOCAL_DATE_TIME", "STRING", "BYTE_BUFFER"

  - `responseList.fields.isReadOnly` (boolean)
    Indicates whether the field is read-only. Read-only fields are taken as input by the masking algorithm but not masked.

  - `responseList.fields.isOptional` (boolean)
    Indicates whether the field is optional. Optional fields do not have to be assigned to a real data field or column in order for a masking assignment to be considered valid.

  - `responseList.fields.description` (string)
    The description of the algorithm field.

  - `responseList.extensionSchema` (object)
    The JSON schema of algorithmExtension used by this framework


## Response 400 fields

## Response 403 fields