### System API - Settings

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Endpoints for managing system settings.

```APIDOC
## GET /system/settings/

### Description
List all system settings.

### Method
GET

### Endpoint
/system/settings/

### Parameters
#### Query Parameters
- **query** (string) - Optional - Search query for filtering settings.
- **limit** (integer) - Optional - Maximum number of settings to return.
- **page** (integer) - Optional - Page number for pagination.
```

```APIDOC
## PATCH /system/settings/

### Description
Update system settings.

### Method
PATCH

### Endpoint
/system/settings/

### Parameters

#### Request Body
- **settings** (object) - Required - An object containing the settings to update.
```

```APIDOC
## GET /system/settings/{key}

### Description
Retrieve the value for a specific system setting key.

### Method
GET

### Endpoint
/system/settings/{key}

### Parameters
#### Path Parameters
- **key** (string) - Required - The key of the setting to retrieve.
```

```APIDOC
## POST /system/settings/{key}

### Description
Set the value for a specific system setting key.

### Method
POST

### Endpoint
/system/settings/{key}

### Parameters
#### Path Parameters
- **key** (string) - Required - The key of the setting to set.

#### Request Body
- **value** (any) - Required - The value to set for the setting.
```

```APIDOC
## GET /system/settings/current

### Description
Retrieve the current system settings.

### Method
GET

### Endpoint
/system/settings/current
```

--------------------------------

### System API - Applications

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Endpoints for managing Corteza applications.

```APIDOC
## GET /system/application/

### Description
List available applications.

### Method
GET

### Endpoint
/system/application/

### Parameters
#### Query Parameters
- **query** (string) - Optional - Search query for applications.
- **limit** (integer) - Optional - Maximum number of applications to return.
- **page** (integer) - Optional - Page number for pagination.
```

```APIDOC
## POST /system/application/

### Description
Create a new application.

### Method
POST

### Endpoint
/system/application/

```

--------------------------------

### System API - Authentication Clients

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Endpoints for managing authentication clients.

```APIDOC
## GET /system/auth/clients/

### Description
List available authentication clients.

### Method
GET

### Endpoint
/system/auth/clients/

### Parameters
#### Query Parameters
- **query** (string) - Optional - Search query for filtering clients.
- **limit** (integer) - Optional - Maximum number of clients to return.
- **page** (integer) - Optional - Page number for pagination.
```

```APIDOC
## POST /system/auth/clients/

### Description
Create a new authentication client.

### Method
POST

### Endpoint
/system/auth/clients/

### Parameters

#### Request Body
- **handle** (string) - Required - A unique handle for the client.
- **name** (string) - Optional - A display name for the client.
- **description** (string) - Optional - A description for the client.
```

```APIDOC
## PUT /system/auth/clients/{clientID}

### Description
Update an existing authentication client's details.

### Method
PUT

### Endpoint
/system/auth/clients/{clientID}

### Parameters
#### Path Parameters
- **clientID** (string) - Required - The ID of the client to update.

#### Request Body
- **name** (string) - Optional - The new display name for the client.
- **description** (string) - Optional - The new description for the client.
```

```APIDOC
## GET /system/auth/clients/{clientID}

### Description
Retrieve details for a specific authentication client.

### Method
GET

### Endpoint
/system/auth/clients/{clientID}

### Parameters
#### Path Parameters
- **clientID** (string) - Required - The ID of the client to retrieve.
```

```APIDOC
## DELETE /system/auth/clients/{clientID}

### Description
Remove an authentication client.

### Method
DELETE

### Endpoint
/system/auth/clients/{clientID}

### Parameters
#### Path Parameters
- **clientID** (string) - Required - The ID of the client to remove.
```

```APIDOC
## POST /system/auth/clients/{clientID}/undelete

### Description
Undelete a previously removed authentication client.

### Method
POST

### Endpoint
/system/auth/clients/{clientID}/undelete

### Parameters
#### Path Parameters
- **clientID** (string) - Required - The ID of the client to undelete.
```

```APIDOC
## POST /system/auth/clients/{clientID}/secret

### Description
Regenerate the secret for an authentication client.

### Method
POST

### Endpoint
/system/auth/clients/{clientID}/secret

### Parameters
#### Path Parameters
- **clientID** (string) - Required - The ID of the client for which to regenerate the secret.
```

```APIDOC
## GET /system/auth/clients/{clientID}/secret

### Description
Expose the secret of an authentication client.

### Method
GET

### Endpoint
/system/auth/clients/{clientID}/secret

### Parameters
#### Path Parameters
- **clientID** (string) - Required - The ID of the client whose secret to expose.
```

--------------------------------

### System Automation Scripts API

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Manage system automation scripts. This includes listing available scripts, serving client script bundles, and triggering script execution.

```APIDOC
## GET /system/automation/

### Description
List all available automation scripts for system resources.

### Method
GET

### Endpoint
/system/automation/

## GET /system/automation/{bundle}-{type}.{ext}

### Description
Serves client scripts bundle.

### Method
GET

### Endpoint
/system/automation/{bundle}-{type}.{ext}

### Parameters
#### Path Parameters
- **bundle** (string) - Required - The name of the bundle.
- **type** (string) - Required - The type of script.
- **ext** (string) - Required - The file extension.

## POST /system/automation/trigger

### Description
Triggers execution of a specific script on a system service level.

### Method
POST

### Endpoint
/system/automation/trigger
```

--------------------------------

### System API - Users

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Endpoints for managing user accounts and their properties.

```APIDOC
## GET /system/users/

### Description
Search users (Directory).

### Method
GET

### Endpoint
/system/users/

### Parameters
#### Query Parameters
- **query** (string) - Optional - Search query for users.
- **limit** (integer) - Optional - Maximum number of users to return.
- **page** (integer) - Optional - Page number for pagination.
```

```APIDOC
## POST /system/users/

### Description
Create a new user account.

### Method
POST

### Endpoint
/system/users/

### Parameters

#### Request Body
- **username** (string) - Required - The username for the new account.
- **email** (string) - Required - The email address for the new account.
- **name** (string) - Optional - The full name of the user.
- **password** (string) - Optional - The initial password for the user.
```

```APIDOC
## PUT /system/users/{userID}

### Description
Update a user's details.

### Method
PUT

### Endpoint
/system/users/{userID}

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user to update.

#### Request Body
- **email** (string) - Optional - The updated email address.
- **name** (string) - Optional - The updated full name.
```

```APIDOC
## PATCH /system/users/{userID}

### Description
Patch user details (experimental).

### Method
PATCH

### Endpoint
/system/users/{userID}

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user to patch.

#### Request Body
- **field** (any) - Required - The field to patch and its new value.
```

```APIDOC
## GET /system/users/{userID}

### Description
Retrieve details for a specific user.

### Method
GET

### Endpoint
/system/users/{userID}

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user to retrieve.
```

```APIDOC
## DELETE /system/users/{userID}

### Description
Remove a user account.

### Method
DELETE

### Endpoint
/system/users/{userID}

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user to remove.
```

```APIDOC
## POST /system/users/{userID}/suspend

### Description
Suspend a user account.

### Method
POST

### Endpoint
/system/users/{userID}/suspend

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user to suspend.
```

```APIDOC
## POST /system/users/{userID}/unsuspend

### Description
Unsuspend a user account.

### Method
POST

### Endpoint
/system/users/{userID}/unsuspend

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user to unsuspend.
```

```APIDOC
## POST /system/users/{userID}/undelete

### Description
Undelete a user account.

### Method
POST

### Endpoint
/system/users/{userID}/undelete

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user to undelete.
```

```APIDOC
## POST /system/users/{userID}/password

### Description
Set or change a user's password.

### Method
POST

### Endpoint
/system/users/{userID}/password

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user whose password to change.

#### Request Body
- **password** (string) - Required - The new password for the user.
```

```APIDOC
## GET /system/users/{userID}/membership

### Description
Get a user's role memberships. Note: The provided text indicates this endpoint should 'Add member to a role', which is contradictory to the GET method. Assuming it retrieves membership information.

### Method
GET

### Endpoint
/system/users/{userID}/membership

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user whose memberships to retrieve.
```

```APIDOC
## POST /system/users/{userID}/membership/{roleID}

### Description
Add a role to a user's memberships.

### Method
POST

### Endpoint
/system/users/{userID}/membership/{roleID}

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user.
- **roleID** (string) - Required - The ID of the role to add to the user.
```

```APIDOC
## DELETE /system/users/{userID}/membership/{roleID}

### Description
Remove a role from a user's memberships.

### Method
DELETE

### Endpoint
/system/users/{userID}/membership/{roleID}

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user.
- **roleID** (string) - Required - The ID of the role to remove from the user.
```

```APIDOC
## POST /system/users/{userID}/trigger

### Description
Fire a system:user trigger.

### Method
POST

### Endpoint
/system/users/{userID}/trigger

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user to trigger.

#### Request Body
- **eventType** (string) - Required - The type of event to trigger.
```

```APIDOC
## DELETE /system/users/{userID}/sessions

### Description
Remove all authentication sessions for a user.

### Method
DELETE

### Endpoint
/system/users/{userID}/sessions

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user whose sessions to remove.
```

```APIDOC
## GET /system/users/{userID}/credentials

### Description
List a user's credentials.

### Method
GET

### Endpoint
/system/users/{userID}/credentials

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user whose credentials to list.
```

```APIDOC
## DELETE /system/users/{userID}/credentials/{credentialsID}

### Description
Delete a user's specific credential.

### Method
DELETE

### Endpoint
/system/users/{userID}/credentials/{credentialsID}

### Parameters
#### Path Parameters
- **userID** (string) - Required - The ID of the user.
- **credentialsID** (string) - Required - The ID of the credential to delete.
```

```APIDOC
## GET /system/users/export/{filename}.zip

### Description
Export users to a zip file.

### Method
GET

### Endpoint
/system/users/export/{filename}.zip

### Parameters
#### Path Parameters
- **filename** (string) - Required - The name for the exported zip file.
```

```APIDOC
## POST /system/users/import

### Description
Import users from a file.

### Method
POST

### Endpoint
/system/users/import

### Parameters

#### Request Body
- **file** (file) - Required - The file containing user data for import.
```

--------------------------------

### System API - Authentication

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Endpoints for managing user authentication and impersonation.

```APIDOC
## POST /system/auth/impersonate

### Description
Impersonate a user.

### Method
POST

### Endpoint
/system/auth/impersonate

### Parameters

#### Request Body
- **user** (string) - Required - The identifier of the user to impersonate.
- **exp** (integer) - Optional - The expiration time for the impersonation token in seconds.
```

--------------------------------

### System API - Roles

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Endpoints for managing user roles and their memberships.

```APIDOC
## GET /system/roles/

### Description
List all roles.

### Method
GET

### Endpoint
/system/roles/

### Parameters
#### Query Parameters
- **query** (string) - Optional - Search query for filtering roles.
- **limit** (integer) - Optional - Maximum number of roles to return.
- **page** (integer) - Optional - Page number for pagination.
```

```APIDOC
## POST /system/roles/

### Description
Create a new role or update existing role details.

### Method
POST

### Endpoint
/system/roles/

### Parameters

#### Request Body
- **name** (string) - Required - The name of the role.
- **description** (string) - Optional - A description for the role.
```

```APIDOC
## PUT /system/roles/{roleID}

### Description
Update an existing role's details.

### Method
PUT

### Endpoint
/system/roles/{roleID}

### Parameters
#### Path Parameters
- **roleID** (string) - Required - The ID of the role to update.

#### Request Body
- **name** (string) - Optional - The new name for the role.
- **description** (string) - Optional - The new description for the role.
```

```APIDOC
## GET /system/roles/{roleID}

### Description
Retrieve details and memberships for a specific role.

### Method
GET

### Endpoint
/system/roles/{roleID}

### Parameters
#### Path Parameters
- **roleID** (string) - Required - The ID of the role to retrieve.
```

```APIDOC
## DELETE /system/roles/{roleID}

### Description
Remove a role.

### Method
DELETE

### Endpoint
/system/roles/{roleID}

### Parameters
#### Path Parameters
- **roleID** (string) - Required - The ID of the role to remove.
```

```APIDOC
## POST /system/roles/{roleID}/archive

### Description
Archive a role.

### Method
POST

### Endpoint
/system/roles/{roleID}/archive

### Parameters
#### Path Parameters
- **roleID** (string) - Required - The ID of the role to archive.
```

```APIDOC
## POST /system/roles/{roleID}/unarchive

### Description
Unarchive a role.

### Method
POST

### Endpoint
/system/roles/{roleID}/unarchive

### Parameters
#### Path Parameters
- **roleID** (string) - Required - The ID of the role to unarchive.
```

```APIDOC
## POST /system/roles/{roleID}/undelete

### Description
Undelete a role.

### Method
POST

### Endpoint
/system/roles/{roleID}/undelete

### Parameters
#### Path Parameters
- **roleID** (string) - Required - The ID of the role to undelete.
```

```APIDOC
## POST /system/roles/{roleID}/move

### Description
Move a role to a different organization.

### Method
POST

### Endpoint
/system/roles/{roleID}/move

### Parameters
#### Path Parameters
- **roleID** (string) - Required - The ID of the role to move.

#### Request Body
- **organizationID** (string) - Required - The ID of the target organization.
```

```APIDOC
## POST /system/roles/{roleID}/merge

### Description
Merge one role into another.

### Method
POST

### Endpoint
/system/roles/{roleID}/merge

### Parameters
#### Path Parameters
- **roleID** (string) - Required - The ID of the role to merge into.

#### Request Body
- **targetRoleID** (string) - Required - The ID of the role to be merged.
```

```APIDOC
## GET /system/roles/{roleID}/members

### Description
Retrieve all members of a specific role.

### Method
GET

### Endpoint
/system/roles/{roleID}/members

### Parameters
#### Path Parameters
- **roleID** (string) - Required - The ID of the role whose members to retrieve.
```

```APIDOC
## POST /system/roles/{roleID}/member/{userID}

### Description
Add a user as a member to a role.

### Method
POST

### Endpoint
/system/roles/{roleID}/member/{userID}

### Parameters
#### Path Parameters
- **roleID** (string) - Required - The ID of the role.
- **userID** (string) - Required - The ID of the user to add.
```

```APIDOC
## DELETE /system/roles/{roleID}/member/{userID}

### Description
Remove a user from a role.

### Method
DELETE

### Endpoint
/system/roles/{roleID}/member/{userID}

### Parameters
#### Path Parameters
- **roleID** (string) - Required - The ID of the role.
- **userID** (string) - Required - The ID of the user to remove.
```

```APIDOC
## POST /system/roles/{roleID}/trigger

### Description
Fire a system:role trigger.

### Method
POST

### Endpoint
/system/roles/{roleID}/trigger

### Parameters
#### Path Parameters
- **roleID** (string) - Required - The ID of the role to trigger.

#### Request Body
- **eventType** (string) - Required - The type of event to trigger.
```

```APIDOC
## POST /system/roles/{roleID}/rules/clone

### Description
Clone permission settings to a role.

### Method
POST

### Endpoint
/system/roles/{roleID}/rules/clone

### Parameters
#### Path Parameters
- **roleID** (string) - Required - The ID of the role to clone permissions to.

#### Request Body
- **sourceRoleID** (string) - Required - The ID of the role to clone permissions from.
```

```APIDOC
## GET /system/roles/{roleID}/members

### Description
Returns all members of a role.

### Method
GET

### Endpoint
/system/roles/{roleID}/members

### Parameters
#### Path Parameters
- **roleID** (string) - Required - The ID of the role to retrieve members for.
```

--------------------------------

### System API - Data Access Layer Drivers

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Endpoints for managing Data Access Layer (DAL) drivers.

```APIDOC
## GET /system/dal/drivers/

### Description
Search and list available Data Access Layer drivers.

### Method
GET

### Endpoint
/system/dal/drivers/

### Parameters
#### Query Parameters
- **query** (string) - Optional - Search query for drivers.
```

--------------------------------

### Statistics API

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Retrieve system statistics.

```APIDOC
## GET /system/stats/

### Description
List system statistics.

### Method
GET

### Endpoint
/system/stats/
```

--------------------------------

### Action Log API

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Retrieve action log events from the system.

```APIDOC
## GET /system/actionlog/

### Description
Action log events.

### Method
GET

### Endpoint
/system/actionlog/
```

--------------------------------

### Integration Gateway Routes API

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Manage integration gateway routes. This includes listing, creating, updating, retrieving, deleting, and undeleting routes.

```APIDOC
## GET /system/apigw/route/

### Description
List routes.

### Method
GET

### Endpoint
/system/apigw/route/

## POST /system/apigw/route

### Description
Create route.

### Method
POST

### Endpoint
/system/apigw/route

## PUT /system/apigw/route/{routeID}

### Description
Update route details.

### Method
PUT

### Endpoint
/system/apigw/route/{routeID}

### Parameters
#### Path Parameters
- **routeID** (string) - Required - The ID of the route to update.

## GET /system/apigw/route/{routeID}

### Description
Read route details.

### Method
GET

### Endpoint
/system/apigw/route/{routeID}

### Parameters
#### Path Parameters
- **routeID** (string) - Required - The ID of the route to retrieve.

## DELETE /system/apigw/route/{routeID}

### Description
Remove route.

### Method
DELETE

### Endpoint
/system/apigw/route/{routeID}

### Parameters
#### Path Parameters
- **routeID** (string) - Required - The ID of the route to remove.

## POST /system/apigw/route/{routeID}/undelete

### Description
Undelete route.

### Method
POST

### Endpoint
/system/apigw/route/{routeID}/undelete

### Parameters
#### Path Parameters
- **routeID** (string) - Required - The ID of the route to undelete.
```

--------------------------------

### Templates API

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Manage templates within the system. This includes listing, creating, reading, updating, deleting, undeleting, and rendering templates.

```APIDOC
## GET /system/template/

### Description
List templates.

### Method
GET

### Endpoint
/system/template/

## POST /system/template/

### Description
Create template.

### Method
POST

### Endpoint
/system/template/

## GET /system/template/{templateID}

### Description
Read template.

### Method
GET

### Endpoint
/system/template/{templateID}

### Parameters
#### Path Parameters
- **templateID** (string) - Required - The ID of the template to read.

## PUT /system/template/{templateID}

### Description
Update template.

### Method
PUT

### Endpoint
/system/template/{templateID}

### Parameters
#### Path Parameters
- **templateID** (string) - Required - The ID of the template to update.

## DELETE /system/template/{templateID}

### Description
Delete template.

### Method
DELETE

### Endpoint
/system/template/{templateID}

### Parameters
#### Path Parameters
- **templateID** (string) - Required - The ID of the template to delete.

## POST /system/template/{templateID}/undelete

### Description
Undelete template.

### Method
POST

### Endpoint
/system/template/{templateID}/undelete

### Parameters
#### Path Parameters
- **templateID** (string) - Required - The ID of the template to undelete.

## GET /system/template/render/drivers

### Description
List available render drivers for templates.

### Method
GET

### Endpoint
/system/template/render/drivers

## POST /system/template/{templateID}/render/{filename}.{ext}

### Description
Render template.

### Method
POST

### Endpoint
/system/template/{templateID}/render/{filename}.{ext}

### Parameters
#### Path Parameters
- **templateID** (string) - Required - The ID of the template to render.
- **filename** (string) - Required - The desired filename for the rendered output.
- **ext** (string) - Required - The file extension for the rendered output.
```

--------------------------------

### System API - Data Access Layer Connections

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Endpoints for managing Data Access Layer (DAL) connections.

```APIDOC
## GET /system/dal/connections/

### Description
Search and list Data Access Layer connections (Directory).

### Method
GET

### Endpoint
/system/dal/connections/

### Parameters
#### Query Parameters
- **query** (string) - Optional - Search query for connections.
```

```APIDOC
## POST /system/dal/connections/

### Description
Create a new Data Access Layer connection.

### Method
POST

### Endpoint
/system/dal/connections/

### Parameters

#### Request Body
- **name** (string) - Required - The name of the connection.
- **driver** (string) - Required - The driver to use for the connection.
- **connection** (object) - Required - Connection configuration details.
```

```APIDOC
## PUT /system/dal/connections/{connectionID}

### Description
Update Data Access Layer connection details.

### Method
PUT

### Endpoint
/system/dal/connections/{connectionID}

### Parameters
#### Path Parameters
- **connectionID** (string) - Required - The ID of the connection to update.

#### Request Body
- **name** (string) - Optional - The new name for the connection.
- **connection** (object) - Optional - The updated connection configuration.
```

```APIDOC
## GET /system/dal/connections/{connectionID}

### Description
Retrieve details for a specific Data Access Layer connection.

### Method
GET

### Endpoint
/system/dal/connections/{connectionID}

### Parameters
#### Path Parameters
- **connectionID** (string) - Required - The ID of the connection to retrieve.
```

```APIDOC
## DELETE /system/dal/connections/{connectionID}

### Description
Remove a Data Access Layer connection.

### Method
DELETE

### Endpoint
/system/dal/connections/{connectionID}

### Parameters
#### Path Parameters
- **connectionID** (string) - Required - The ID of the connection to remove.
```

```APIDOC
## POST /system/dal/connections/{connectionID}/undelete

### Description
Undelete a Data Access Layer connection.

### Method
POST

### Endpoint
/system/dal/connections/{connectionID}/undelete

### Parameters
#### Path Parameters
- **connectionID** (string) - Required - The ID of the connection to undelete.
```

--------------------------------

### Integration Gateway Profiler API

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Access integration gateway profiler data. This includes listing aggregated routes, listing hits per route, and retrieving hit details.

```APIDOC
## GET /system/apigw/profiler/

### Description
List aggregated list of routes.

### Method
GET

### Endpoint
/system/apigw/profiler/

## GET /system/apigw/profiler/route/{routeID}

### Description
List hits per route.

### Method
GET

### Endpoint
/system/apigw/profiler/route/{routeID}

### Parameters
#### Path Parameters
- **routeID** (string) - Required - The ID of the route to list hits for.

## GET /system/apigw/profiler/hit/{hitID}

### Description
Hit details.

### Method
GET

### Endpoint
/system/apigw/profiler/hit/{hitID}

### Parameters
#### Path Parameters
- **hitID** (string) - Required - The ID of the hit to retrieve details for.
```

--------------------------------

### System API - Data Access Layer Sensitivity Levels

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Endpoints for managing Data Access Layer (DAL) sensitivity levels.

```APIDOC
## GET /system/dal/sensitivity-levels/

### Description
Search and list Data Access Layer sensitivity levels.

### Method
GET

### Endpoint
/system/dal/sensitivity-levels/

### Parameters
#### Query Parameters
- **query** (string) - Optional - Search query for sensitivity levels.
```

```APIDOC
## POST /system/dal/sensitivity-levels/

### Description
Create a new Data Access Layer sensitivity level.

### Method
POST

### Endpoint
/system/dal/sensitivity-levels/

### Parameters

#### Request Body
- **name** (string) - Required - The name of the sensitivity level.
- **description** (string) - Optional - A description for the sensitivity level.
```

```APIDOC
## PUT /system/dal/sensitivity-levels/{sensitivityLevelID}

### Description
Update Data Access Layer sensitivity level details.

### Method
PUT

### Endpoint
/system/dal/sensitivity-levels/{sensitivityLevelID}

### Parameters
#### Path Parameters
- **sensitivityLevelID** (string) - Required - The ID of the sensitivity level to update.

#### Request Body
- **name** (string) - Optional - The new name for the sensitivity level.
- **description** (string) - Optional - The new description for the sensitivity level.
```

```APIDOC
## GET /system/dal/sensitivity-levels/{sensitivityLevelID}

### Description
Retrieve details for a specific Data Access Layer sensitivity level.

### Method
GET

### Endpoint
/system/dal/sensitivity-levels/{sensitivityLevelID}

### Parameters
#### Path Parameters
- **sensitivityLevelID** (string) - Required - The ID of the sensitivity level to retrieve.
```

```APIDOC
## DELETE /system/dal/sensitivity-levels/{sensitivityLevelID}

### Description
Remove a Data Access Layer sensitivity level.

### Method
DELETE

### Endpoint
/system/dal/sensitivity-levels/{sensitivityLevelID}

### Parameters
#### Path Parameters
- **sensitivityLevelID** (string) - Required - The ID of the sensitivity level to remove.
```

```APIDOC
## POST /system/dal/sensitivity-levels/{sensitivityLevelID}/undelete

### Description
Undelete a Data Access Layer sensitivity level.

### Method
POST

### Endpoint
/system/dal/sensitivity-levels/{sensitivityLevelID}/undelete

### Parameters
#### Path Parameters
- **sensitivityLevelID** (string) - Required - The ID of the sensitivity level to undelete.
```

--------------------------------

### Integration Gateway Filters API

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Manage integration gateway filters. This includes listing, creating, updating, retrieving, deleting, undeleting filters, and retrieving filter definitions.

```APIDOC
## GET /system/apigw/filter/

### Description
List filters.

### Method
GET

### Endpoint
/system/apigw/filter/

## PUT /system/apigw/filter

### Description
Create filter.

### Method
PUT

### Endpoint
/system/apigw/filter

## POST /system/apigw/filter/{filterID}

### Description
Update filter details.

### Method
POST

### Endpoint
/system/apigw/filter/{filterID}

### Parameters
#### Path Parameters
- **filterID** (string) - Required - The ID of the filter to update.

## GET /system/apigw/filter/{filterID}

### Description
Read filter details.

### Method
GET

### Endpoint
/system/apigw/filter/{filterID}

### Parameters
#### Path Parameters
- **filterID** (string) - Required - The ID of the filter to retrieve.

## DELETE /system/apigw/filter/{filterID}

### Description
Remove filter.

### Method
DELETE

### Endpoint
/system/apigw/filter/{filterID}

### Parameters
#### Path Parameters
- **filterID** (string) - Required - The ID of the filter to remove.

## POST /system/apigw/filter/{filterID}/undelete

### Description
Undelete filter.

### Method
POST

### Endpoint
/system/apigw/filter/{filterID}/undelete

### Parameters
#### Path Parameters
- **filterID** (string) - Required - The ID of the filter to undelete.

## GET /system/apigw/filter/def

### Description
Filter definitions.

### Method
GET

### Endpoint
/system/apigw/filter/def

## GET /system/apigw/filter/proxy_auth/def

### Description
Proxy auth definitions.

### Method
GET

### Endpoint
/system/apigw/filter/proxy_auth/def
```

--------------------------------

### Data Privacy Connection API

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

List connections for data privacy purposes.

```APIDOC
## GET /system/data-privacy/connection/

### Description
List connections for data privacy.

### Method
GET

### Endpoint
/system/data-privacy/connection/
```

--------------------------------

### Attachments API

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Manage attachments within the system. This includes retrieving attachment details, deleting attachments, serving original files, and serving file previews.

```APIDOC
## GET /system/attachment/{kind}/{attachmentID}

### Description
Attachment details.

### Method
GET

### Endpoint
/system/attachment/{kind}/{attachmentID}

### Parameters
#### Path Parameters
- **kind** (string) - Required - The kind of attachment.
- **attachmentID** (string) - Required - The ID of the attachment.

## DELETE /system/attachment/{kind}/{attachmentID}

### Description
Delete attachment.

### Method
DELETE

### Endpoint
/system/attachment/{kind}/{attachmentID}

### Parameters
#### Path Parameters
- **kind** (string) - Required - The kind of attachment.
- **attachmentID** (string) - Required - The ID of the attachment.

## GET /system/attachment/{kind}/{attachmentID}/original/{name}

### Description
Serves attached file.

### Method
GET

### Endpoint
/system/attachment/{kind}/{attachmentID}/original/{name}

### Parameters
#### Path Parameters
- **kind** (string) - Required - The kind of attachment.
- **attachmentID** (string) - Required - The ID of the attachment.
- **name** (string) - Required - The name of the original file.

## GET /system/attachment/{kind}/{attachmentID}/preview.{ext}

### Description
Serves preview of an attached file.

### Method
GET

### Endpoint
/system/attachment/{kind}/{attachmentID}/preview.{ext}

### Parameters
#### Path Parameters
- **kind** (string) - Required - The kind of attachment.
- **attachmentID** (string) - Required - The ID of the attachment.
- **ext** (string) - Required - The file extension for the preview.
```

--------------------------------

### Locale API

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Manage locale and translations within the system. This includes listing and managing resource translations, and listing available languages and translations for specific applications.

```APIDOC
## GET /system/locale/resource

### Description
List resources translations.

### Method
GET

### Endpoint
/system/locale/resource

## POST /system/locale/resource

### Description
Create resource translation.

### Method
POST

### Endpoint
/system/locale/resource

## PUT /system/locale/resource/{translationID}

### Description
Update resource translation.

### Method
PUT

### Endpoint
/system/locale/resource/{translationID}

### Parameters
#### Path Parameters
- **translationID** (string) - Required - The ID of the resource translation to update.

## GET /system/locale/resource/{translationID}

### Description
Read resource translation details.

### Method
GET

### Endpoint
/system/locale/resource/{translationID}

### Parameters
#### Path Parameters
- **translationID** (string) - Required - The ID of the resource translation to retrieve.

## DELETE /system/locale/resource/{translationID}

### Description
Remove resource translation.

### Method
DELETE

### Endpoint
/system/locale/resource/{translationID}

### Parameters
#### Path Parameters
- **translationID** (string) - Required - The ID of the resource translation to remove.

## POST /system/locale/resource/{translationID}/undelete

### Description
Undelete resource translation.

### Method
POST

### Endpoint
/system/locale/resource/{translationID}/undelete

### Parameters
#### Path Parameters
- **translationID** (string) - Required - The ID of the resource translation to undelete.

## GET /system/locale/

### Description
List all available languages.

### Method
GET

### Endpoint
/system/locale/

## GET /system/locale/{lang}/{application}

### Description
List all available translations in a language for a specific webapp.

### Method
GET

### Endpoint
/system/locale/{lang}/{application}

### Parameters
#### Path Parameters
- **lang** (string) - Required - The language code.
- **application** (string) - Required - The application name.
```

--------------------------------

### Messaging Queues API

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Manage messaging queues within the system. This includes listing, creating, retrieving details, updating, deleting, and undeleting queues.

```APIDOC
## GET /system/queues/

### Description
Messaging queues.

### Method
GET

### Endpoint
/system/queues/

## POST /system/queues

### Description
Create messaging queue.

### Method
POST

### Endpoint
/system/queues

## GET /system/queues/{queueID}

### Description
Messaging queue details.

### Method
GET

### Endpoint
/system/queues/{queueID}

### Parameters
#### Path Parameters
- **queueID** (string) - Required - The ID of the messaging queue.

## PUT /system/queues/{queueID}

### Description
Update queue details.

### Method
PUT

### Endpoint
/system/queues/{queueID}

### Parameters
#### Path Parameters
- **queueID** (string) - Required - The ID of the messaging queue to update.

## DELETE /system/queues/{queueID}

### Description
Messaging queue delete.

### Method
DELETE

### Endpoint
/system/queues/{queueID}

### Parameters
#### Path Parameters
- **queueID** (string) - Required - The ID of the messaging queue to delete.

## POST /system/queues/{queueID}/undelete

### Description
Messaging queue undelete.

### Method
POST

### Endpoint
/system/queues/{queueID}/undelete

### Parameters
#### Path Parameters
- **queueID** (string) - Required - The ID of the messaging queue to undelete.
```

--------------------------------

### Reports API

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Manage reports within the system. This includes listing, creating, updating, retrieving, deleting, undeleting, describing, and running reports.

```APIDOC
## GET /system/reports/

### Description
List reports.

### Method
GET

### Endpoint
/system/reports/

## POST /system/reports/

### Description
Create report.

### Method
POST

### Endpoint
/system/reports/

## PUT /system/reports/{reportID}

### Description
Update report.

### Method
PUT

### Endpoint
/system/reports/{reportID}

### Parameters
#### Path Parameters
- **reportID** (string) - Required - The ID of the report to update.

## GET /system/reports/{reportID}

### Description
Read report details.

### Method
GET

### Endpoint
/system/reports/{reportID}

### Parameters
#### Path Parameters
- **reportID** (string) - Required - The ID of the report to retrieve.

## DELETE /system/reports/{reportID}

### Description
Remove report.

### Method
DELETE

### Endpoint
/system/reports/{reportID}

### Parameters
#### Path Parameters
- **reportID** (string) - Required - The ID of the report to delete.

## POST /system/reports/{reportID}/undelete

### Description
Undelete report.

### Method
POST

### Endpoint
/system/reports/{reportID}/undelete

### Parameters
#### Path Parameters
- **reportID** (string) - Required - The ID of the report to undelete.

## POST /system/reports/describe

### Description
Describe report.

### Method
POST

### Endpoint
/system/reports/describe

## POST /system/reports/{reportID}/run

### Description
Run report.

### Method
POST

### Endpoint
/system/reports/{reportID}/run

### Parameters
#### Path Parameters
- **reportID** (string) - Required - The ID of the report to run.
```

--------------------------------

### Reminders API

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Manage reminders within the system. This includes listing, adding, updating, retrieving, deleting, dismissing, and snoozing reminders.

```APIDOC
## GET /system/reminder/

### Description
List/read reminders.

### Method
GET

### Endpoint
/system/reminder/

## POST /system/reminder/

### Description
Add new reminder.

### Method
POST

### Endpoint
/system/reminder/

## PUT /system/reminder/{reminderID}

### Description
Update reminder.

### Method
PUT

### Endpoint
/system/reminder/{reminderID}

### Parameters
#### Path Parameters
- **reminderID** (string) - Required - The ID of the reminder to update.

## GET /system/reminder/{reminderID}

### Description
Read reminder by ID.

### Method
GET

### Endpoint
/system/reminder/{reminderID}

### Parameters
#### Path Parameters
- **reminderID** (string) - Required - The ID of the reminder to retrieve.

## DELETE /system/reminder/{reminderID}

### Description
Delete reminder.

### Method
DELETE

### Endpoint
/system/reminder/{reminderID}

### Parameters
#### Path Parameters
- **reminderID** (string) - Required - The ID of the reminder to delete.

## PATCH /system/reminder/{reminderID}/dismiss

### Description
Dismiss reminder.

### Method
PATCH

### Endpoint
/system/reminder/{reminderID}/dismiss

### Parameters
#### Path Parameters
- **reminderID** (string) - Required - The ID of the reminder to dismiss.

## PATCH /system/reminder/{reminderID}/snooze

### Description
Snooze reminder.

### Method
PATCH

### Endpoint
/system/reminder/{reminderID}/snooze

### Parameters
#### Path Parameters
- **reminderID** (string) - Required - The ID of the reminder to snooze.
```

--------------------------------

### Data Privacy Request Comments API

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Manage comments for data privacy requests. This includes listing and creating comments.

```APIDOC
## GET /system/data-privacy/requests/{requestID}/comments/

### Description
List data privacy request comments.

### Method
GET

### Endpoint
/system/data-privacy/requests/{requestID}/comments/

### Parameters
#### Path Parameters
- **requestID** (string) - Required - The ID of the data privacy request.

## POST /system/data-privacy/requests/{requestID}/comments/

### Description
Create data privacy request comment.

### Method
POST

### Endpoint
/system/data-privacy/requests/{requestID}/comments/

### Parameters
#### Path Parameters
- **requestID** (string) - Required - The ID of the data privacy request.
```

--------------------------------

### Data Privacy Request API

Source: https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2024.9/index

Manage data privacy requests. This includes listing, creating, updating status, and retrieving details of requests.

```APIDOC
## GET /system/data-privacy/requests/

### Description
List data privacy requests.

### Method
GET

### Endpoint
/system/data-privacy/requests/

## POST /system/data-privacy/requests/

### Description
Create data privacy request.

### Method
POST

### Endpoint
/system/data-privacy/requests/

## PATCH /system/data-privacy/requests/{requestID}/status/{status}

### Description
Update data privacy request status.

### Method
PATCH

### Endpoint
/system/data-privacy/requests/{requestID}/status/{status}

### Parameters
#### Path Parameters
- **requestID** (string) - Required - The ID of the data privacy request.
- **status** (string) - Required - The new status for the request.

## GET /system/data-privacy/requests/{requestID}

### Description
Get details about specific request.

### Method
GET

### Endpoint
/system/data-privacy/requests/{requestID}

### Parameters
#### Path Parameters
- **requestID** (string) - Required - The ID of the data privacy request.
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.