# Generate a report listing all usage of profile sets on the masking engine

Endpoint: GET /profile-sets/usage
Version: 5.1.43
Security: api_key

## Query parameters:

  - `includeAssignmentDetail` (boolean, required)
    Whether to include extended, human-readable profile set assignment detail in the report.

  - `profileSetType` (string)
    Whether to filter by specific profile set type. If not specified, all profile set types are included.
    Enum: "ASDD", "LEGACY"

  - `connectorType` (string)
    Whether to filter by specific connector type. If not specified, all connector types are included.
    Enum: "DATABASE", "FILE", "MAINFRAME"

  - `environmentFilter` (array)
    Report only usage occurring within the specified environment(s).

  - `profileSetFilter` (array)
    Report only usage of the specified profile set(s).

## 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)

  - `responseList.profileSetName` (string, required)
    The name of the profile set to which this usage report applies.

  - `responseList.profileSetId` (integer, required)
    The ID of the profile set to which this usage report applies.

  - `responseList.jobIds` (array)
    A list of the IDs of all jobs where the profile set is used.

  - `responseList.assignmentDetails` (array)
    A extended usage objects that describe the full path to each profile set usage for all assignments.

  - `responseList.assignmentDetails.assignmentType` (string)
    The type of profile set usage.
    Enum: "DATABASE", "FILE", "MAINFRAME"

  - `responseList.assignmentDetails.environmentName` (string)
    The environment where the profile set usage occurs, if any.

  - `responseList.assignmentDetails.environmentId` (integer)
    The ID of the environment where the profile set usage occurs, if any.

  - `responseList.assignmentDetails.jobName` (string)
    The job where the profile set usage occurs, if any.

  - `responseList.assignmentDetails.jobId` (integer)
    The ID of the job where the profile set usage occurs, if any.

  - `responseList.assignmentDetails.rulesetName` (string)
    The target ruleset where the profile set usage occurs, if any.

  - `responseList.assignmentDetails.rulesetId` (integer)
    The ID of the target ruleset where the profile set usage occurs, if any.


## Response 400 fields

## Response 401 fields

## Response 404 fields