Configuration

Create new configuration

Creates a new configuration for the current user. The configuration is stored in the users workspace and can be used for validation of business partners and identifiers.

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

Configuration of the validation process for a single Business Partner record.

name
string

The name of the configuration.

Example: "Custom configuration name"
Responses
200

Configuration created successfully

400

Bad Request.

post/configurations/businesspartnervalidation
Request samples
application/json
{}
Response samples
application/json
{}

Delete configuration

Deletes a configuration for the current user.

SecurityapiKey
Request
path Parameters
configurationId
required
string (schemas-ConfigurationId)

Configuration ID.

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

OK.

400

Bad Request.

delete/configurations/businesspartnervalidation/{configurationId}
Request samples
Response samples
application/json
{}

Fetch existing configuration

Fetches an existing configuration for the current user.

SecurityapiKey
Request
path Parameters
configurationId
required
string (schemas-ConfigurationId)

Configuration ID.

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

Configuration updated successful.

get/configurations/businesspartnervalidation/{configurationId}
Request samples
Response samples
application/json
{}

Find current users configuration

Fetches the current users' configuration. If no configuration exists, a default configuration is returned.

SecurityapiKey
Request
query Parameters
limit
integer (Limit)

Maximum number of results to return. The default is 100.

Example: limit=100
startAfter
string (StartAfter)

Start after the given index. Use this to paginate through the results. The first page is returned if this parameter is not provided.

Example: startAfter=5712566172571652
Responses
200

Successful operation

get/configurations/businesspartnervalidation
Request samples
Response samples
application/json
{
  • "startAfter": "0",
  • "nextStartAfter": "1",
  • "total": 2,
  • "values": [
    ]
}

Update existing configuration

Updates an existing configuration for the current user.

SecurityapiKey
Request
path Parameters
configurationId
required
string (schemas-ConfigurationId)

Configuration ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Request Body schema: application/json
object (BusinessPartnerValidationConfiguration)

Configuration of the validation process for a single Business Partner record.

featuresOn
Array of strings (WorkspaceConfigurationUpdateFeaturesOn)

Features to be enabled.

Items Value: Description
REEVALUATION_ON_CHANGES

Re-evaluates business partners based on changes in the configuration.

Example: ["REEVALUATION_ON_CHANGES"]
name
string

The name of the configuration.

Example: "Custom configuration name"
Responses
200

Configuration updated successful.

400

Bad Request.

put/configurations/businesspartnervalidation/{configurationId}
Request samples
application/json
{
  • "name": "demo config",
  • "configuration": { }
}
Response samples
application/json
{
  • "name": "demo config",
  • "id": "63a1d5a13b5faf2f613164c0",
  • "createdAt": "2022-12-20T15:32:49.579Z",
  • "modifiedAt": "2022-12-20T15:43:43.158949713Z",
  • "createdBy": "demo"
}