Augmented Business Partners

Read a Page of Augmented Business Partners

SecurityapiKey
Request
path Parameters
storageId
required
string
query Parameters
dataSourceId
string

Data source ID used to filter the result of business partners returned.

externalIds
Array of strings

List of externalIds used to filter the result of business partners returned.

from
string

Filter updates by date.

Example: from=2019-12-31T16:47
limit
integer <int32> [ 1 .. 100 ]
Default: 100

Number of items to be returned on the page.

startAfter
string

Only items with an ID greater than the given one will be retrieved.

When nextStartAfter provided in the response, should be used instead of the ID as an indicator for a next page.

typeTechnicalKeys
Array of strings

List of types used to filter the result of business partners returned.

Responses
200

OK

get/storages/{storageId}/augmentedbusinesspartners
Request samples
Response samples
application/json
{
  • "limit": 0,
  • "total": 0,
  • "startAfter": "string",
  • "nextStartAfter": "string",
  • "values": [
    ]
}

Read an Augmented Business Partner

SecurityapiKey
Request
path Parameters
dataSourceId
required
string
storageId
required
string
Request Body schema: application/json
externalId
required
string (BusinessPartnerExternalId)

ID the record has in the external system where the record originates from.

from
string

Filter updates by date.

Responses
200

OK

post/storages/{storageId}/datasources/{dataSourceId}/augmentedbusinesspartners/fetch
Request samples
application/json
{
  • "externalId": "string",
  • "from": "2019-12-31T16:47"
}
Response samples
application/json
{
  • "augmentedBusinessPartner": {
    },
  • "augmentedChanges": [
    ],
  • "requestSimilarity": {
    },
  • "updates": [
    ],
  • "executedAt": "string"
}