# Get algorithm framework by frameworkId

Endpoint: GET /algorithm/frameworks/id/{frameworkId}
Version: 5.1.41
Security: api_key

## Path parameters:

  - `frameworkId` (integer, required)
    The id of the framework

## Query parameters:

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

## Response 200 fields (application/json):

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

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

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

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

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

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

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

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

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

  - `fields` (array)

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

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

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

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

  - `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.

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

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


## Response 400 fields

## Response 403 fields