Configurations

Manage configurations for compliance list screening. These endpoints allow for the listing, creation, reading, updating, and deletion of configurations. The configurations are essential for defining the parameters of the screening process.

Create a Configuration

Create a new configuration for compliance list screening.

SecurityapiKey
Request
Request Body schema: application/json
object (ComplianceListsScreeningSettings)

Defines settings for compliance list screening.

name
string (ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
workspaceId
string (WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
Responses
200

Configuration created successfully

400

Bad Request.

post/configurations/compliancelistsscreening
Request samples
application/json
{
  • "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "name": "Client configuration.",
  • "configuration": {
    }
}
Response samples
application/json
{
  • "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "name": "Client configuration.",
  • "version": 1,
  • "configuration": {
    },
  • "createdAt": "2024-12-21T01:35:24Z",
  • "modifiedAt": "2024-12-21T01:35:24Z",
  • "createdBy": "76248934691294444"
}

Delete Configuration

Delete existing configuration for compliance list screening by id.

SecurityapiKey
Request
path Parameters
configurationId
required
string

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Responses
200

OK.

400

Bad Request.

delete/configurations/compliancelistsscreening/{configurationId}
Request samples 
Response samples 
application/json
{
  • "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "name": "Client configuration.",
  • "version": 1,
  • "configuration": {
    },
  • "createdAt": "2024-12-21T01:35:24Z",
  • "modifiedAt": "2024-12-21T01:35:24Z",
  • "createdBy": "76248934691294444"
}
List Configurations
List all existing configurations for compliance list screening.


SecurityapiKey 
Request 
query Parameters
defaultConfiguration
boolean
 Default:  null
Limit search to configurations with provided default flag value. If left empty, all configurations will be returned.


 
 Example:  defaultConfiguration=true
limit
integer <int32>   >= 1 
 Default:  500
Number of resources to be returned on the page.


 
 Example:  limit=200
startAfter
string
Pagination cursor which should be filled with nextStartAfter value provided in the previous page read response.


 
 Example:  startAfter=NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm
Responses 
200
Successful operation


get/configurations/compliancelistsscreening
Request samples 
Response samples 
application/json
{
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "total": "67",
  • "values": [
    ]
}
Read Compliance List Screening Configuration Version
Read a specific version of a compliance list screening configuration by id and version number.


SecurityapiKey 
Request 
path Parameters
configurationId
required
string
ID of the configuration.


 
 Example:  c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
version
required
integer
Version number of the configuration.


 
 Example:  1
Responses 
200
Successful operation.


get/configurations/compliancelistsscreening/{configurationId}/versions/{version}
Request samples 
Response samples 
application/json
{
  • "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "version": 1,
  • "configuration": {
    },
  • "createdAt": "2024-12-21T01:35:24Z",
  • "createdBy": "76248934691294444"
}
Read Configuration
Read existing configuration for compliance list screening by id.


SecurityapiKey 
Request 
path Parameters
configurationId
required
string
ID of the configuration.


 
 Example:  c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Responses 
200
Successful operation


get/configurations/compliancelistsscreening/{configurationId}
Request samples 
Response samples 
application/json
{
  • "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "name": "Client configuration.",
  • "version": 1,
  • "configuration": {
    },
  • "createdAt": "2024-12-21T01:35:24Z",
  • "modifiedAt": "2024-12-21T01:35:24Z",
  • "createdBy": "76248934691294444"
}
Update Configuration
Update existing configuration for compliance list screening by id.


SecurityapiKey 
Request 
path Parameters
configurationId
required
string
ID of the configuration.


 
 Example:  c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Request Body schema: application/json
object (ComplianceListsScreeningSettings) 
Defines settings for compliance list screening.


 
name
string (ConfigurationName) 
Display name for a configuration.


 
 Example:  "Client configuration."
Responses 
200
Configuration updated successful


400
Bad Request.


put/configurations/compliancelistsscreening/{configurationId}
Request samples 
application/json
{
  • "name": "Client configuration.",
  • "configuration": {
    }
}
Response samples 
application/json
{
  • "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "name": "Client configuration.",
  • "version": 1,
  • "configuration": {
    },
  • "createdAt": "2024-12-21T01:35:24Z",
  • "modifiedAt": "2024-12-21T01:35:24Z",
  • "createdBy": "76248934691294444"
}