Configuration

Used to create, read, update, and delete the configurations which define the settings for the augmentation process of Business Partners.

Create augmentation configuration

Endpoint to create a new augmentation configuration.

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

The effective settings for the augmentation.

name
string (ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
Responses
200

Augmentation configuration created successfully

400

Bad Request.

post/configurations/augmentation
Request samples
application/json
{
  • "configuration": {
    },
  • "name": "Client configuration."
}
Response samples
application/json
{
  • "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "name": "Client configuration.",
  • "createdAt": "2024-07-11T07:22:25Z",
  • "createdBy": "76248934691294444",
  • "modifiedAt": "2024-07-11T07:22:25Z",
  • "modifiedBy": "76248934691294444",
  • "configuration": {
    },
  • "relatedConfigurations": [
    ]
}

Delete augmentation configuration

Endpoint to delete an existing augmentation configuration.

SecurityapiKey
Request
path Parameters
configurationId
required
string (ConfigurationId)

Filter by specified Configuration ID.

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

OK.

400

Bad Request.

delete/configurations/augmentation/{configurationId}
Request samples
Response samples
application/json
{
  • "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "name": "Client configuration.",
  • "createdAt": "2024-07-11T07:22:25Z",
  • "createdBy": "76248934691294444",
  • "modifiedAt": "2024-07-11T07:22:25Z",
  • "modifiedBy": "76248934691294444",
  • "configuration": {
    },
  • "relatedConfigurations": [
    ]
}

List configurations

Read augmentation configurations of this workspace.

SecurityapiKey
Request
query Parameters
limit
integer (Limit)

Size of the page.

Example: limit=100
startAfter
string (StartAfter)

Pagination parameter for determining next page.

Example: startAfter=5712566172571652
Responses
200

Successful operation

get/configurations/augmentation
Request samples
Response samples
application/json
{
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "total": "67",
  • "values": [
    ]
}

Read configuration

Endpoint to retrieve an augmentation configuration based on its ID.

SecurityapiKey
Request
path Parameters
configurationId
required
string (ConfigurationId)

Filter by specified Configuration ID.

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

Successful operation

get/configurations/augmentation/{configurationId}
Request samples
Response samples
application/json
{
  • "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "name": "Client configuration.",
  • "createdAt": "2024-07-11T07:22:25Z",
  • "createdBy": "76248934691294444",
  • "modifiedAt": "2024-07-11T07:22:25Z",
  • "modifiedBy": "76248934691294444",
  • "configuration": {
    },
  • "relatedConfigurations": [
    ]
}

Update existing augmentation configuration

Endpoint to update an existing augmentation configuration.

SecurityapiKey
Request
path Parameters
configurationId
required
string (ConfigurationId)

Filter by specified Configuration ID.

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

The effective settings for the augmentation.

featuresOn
Array of strings (AugmentationConfigurationUpdateFeaturesOn)

Features to be activated.

Items Value: Description
REEVALUATION_ON_CHANGES

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

Example: ["REEVALUATION_ON_CHANGES"]
name
string (ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
Responses
200

Augmentation configuration updated successfully

400

Bad Request.

put/configurations/augmentation/{configurationId}
Request samples
application/json
{
  • "configuration": {
    },
  • "name": "Client configuration.",
  • "featuresOn": [
    ]
}
Response samples
application/json
{
  • "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "name": "Client configuration.",
  • "createdAt": "2024-07-11T07:22:25Z",
  • "createdBy": "76248934691294444",
  • "modifiedAt": "2024-07-11T07:22:25Z",
  • "modifiedBy": "76248934691294444",
  • "configuration": {
    },
  • "relatedConfigurations": [
    ]
}