Business Partners

Create Business Partner Tags

Create Business Partner Tags

SecurityapiKey
Request
path Parameters
businessPartnerId
required
string

Business Partner identifier within a storage.

storageId
required
string

Unique ID of a storage.

Request Body schema: application/json
required
required
Array of objects (TagCreate) <= 30 items
Responses
200

OK

400

Bad Request

post/v4/storages/{storageId}/businesspartners/{businessPartnerId}/profile/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "tags": [
    ],
  • "results": [
    ]
}

Delete Business Partner Tags

Delete Business Partner Tags

SecurityapiKey
Request
path Parameters
businessPartnerId
required
string

Business Partner identifier within a storage.

storageId
required
string

Unique ID of a storage.

Request Body schema: application/json
required
required
Array of objects (TagDelete) <= 30 items
Responses
200

OK

400

Bad Request

post/v4/storages/{storageId}/businesspartners/{businessPartnerId}/profile/tags/delete
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "tags": [
    ],
  • "results": [
    ]
}

Delete Business Partners WSDL

Delete batches of business partners by ID or a combination of DataSource and External ID. Maximum of 1000 business partners are allowed per batch. In case only a data source is provided in the request, all business partners related to this data source will be delete, but the data source itself will not be deleted.

SecurityapiKey
Request
path Parameters
storageId
required
string

storageId

Request Body schema: application/json
required

cmd

Array of objects <= 1000 items
dataSource
string (BusinessPartnerStorageDataSourceId)

Unique identifier for a Data Source of the Storage.

featuresOn
Array of strings (DeleteFeatureParam)
Items Enum: "DELETE_BY_EXTERNAL_ID" "DELETE_BUSINESS_PARTNER_DATA" "DELETE_LINKS"
Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/storages/{storageId}/businesspartners/delete
Request samples
application/json
{
  • "dataSource": "YOUR_DATASOURCE_ID",
  • "businessPartners": [
    ],
  • "featuresOn": [
    ]
}
Response samples
application/json
{
  • "numberOfDeletes": "50",
  • "numberOfFailures": "0",
  • "failures": [
    ]
}

Fetch Business Partner

Fetch a Business Partner from this storage

SecurityapiKey
Request
path Parameters
storageId
required
string

storageId

Request Body schema: application/json
required
dataSource
string (BusinessPartnerStorageDataSourceId)

Unique identifier for a Data Source of the Storage.

externalId
required
string (BusinessPartnerExternalId)

Arbitrary identifier type to mark customer IDs that are "external" from CDQ's perspective. This is the identifier a customer provides to identify its records.

featuresOff
Array of strings (FetchBusinessPartnerFeatureParam)

Feature(s) to be excluded during the fetch business partner:

  • FETCH_RECORD - Allows to switch fetching record field to reduce data size. By default turned on.
  • FETCH_RELATIONS - Allows to switch fetching relations of Business Partners. By default turned off. Only for storages with RELATIONS feature enabled
Items Enum: "FETCH_RECORD" "FETCH_RELATIONS"
featuresOn
Array of strings (FetchBusinessPartnerFeatureParam)

Feature(s) to be used during the fetch business partner:

  • FETCH_RECORD - Allows to switch fetching record field to reduce data size. By default turned on.
  • FETCH_RELATIONS - Allows to switch fetching relations of Business Partners. By default turned off. Only for storages with RELATIONS feature enabled
Items Enum: "FETCH_RECORD" "FETCH_RELATIONS"
Responses
200

OK

401

Unauthorized

403

Forbidden

post/v4/storages/{storageId}/businesspartners/fetch
Request samples
application/json
{
  • "externalId": "The ID managed in the customer's SAP systems.",
  • "dataSource": "648824a691d8d2503d65103e",
  • "featuresOn": [
    ],
  • "featuresOff": [
    ]
}
Response samples
application/json
{
  • "businessPartner": {
    },
  • "status": "string",
  • "message": "string"
}

Lookup Business Partner WSDL

Lookup a Business Partner in this storage.

SecurityapiKey
Request
path Parameters
storageId
required
string

storageId

Request Body schema: application/json
required

cmd

object (BusinessPartnerLookupParam)
dataSources
Array of strings

List of Data Sources.

featuresOff
Array of strings (FetchBusinessPartnerFeatureParam)

Feature(s) to be excluded during the fetch business partner:

  • FETCH_RECORD - Allows to switch fetching record field to reduce data size. By default turned on.
  • FETCH_RELATIONS - Allows to switch fetching relations of Business Partners. By default turned off. Only for storages with RELATIONS feature enabled
Items Enum: "FETCH_RECORD" "FETCH_RELATIONS"
featuresOn
Array of strings (FetchBusinessPartnerFeatureParam)

Feature(s) to be used during the fetch business partner:

  • FETCH_RECORD - Allows to switch fetching record field to reduce data size. By default turned on.
  • FETCH_RELATIONS - Allows to switch fetching relations of Business Partners. By default turned off. Only for storages with RELATIONS feature enabled
Items Enum: "FETCH_RECORD" "FETCH_RELATIONS"
matchingThreshold
number <double> [ 0 .. 1 ]
Default: 0
page
integer >= 0
Default: 0
pageSize
integer [ 1 .. 1000 ]
Default: 10
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/v4/storages/{storageId}/businesspartners/lookup
Request samples
application/json
{
  • "matchingThreshold": 0,
  • "pageSize": 10,
  • "page": 0,
  • "dataSources": [
    ],
  • "businessPartner": {
    },
  • "featuresOn": [
    ],
  • "featuresOff": [
    ]
}
Response samples
application/json
{
  • "pageSize": 0,
  • "total": 0,
  • "page": 0,
  • "values": [
    ],
  • "debugInfo": {
    }
}

Poll Toggle Update Monitoring Job

SecurityapiKey
Request
path Parameters
jobId
required
string

jobId

Responses
200

OK

get/jobs/toggleUpdateMonitoringJobs/{jobId}
Request samples 
Response samples 
application/json
{
  • "job": {
    },
  • "status": "string"
}
Random Business Partners
Get random Business Partners from this storage


SecurityapiKey 
Request 
path Parameters
storageId
required
string
storageId


 
query Parameters
countryCode
string
A country code used to filter the result of business partners returned.


 
dataSource
string
Data source (name or ID) used to filter the result of business partners returned.


 
featureOff
Array of strings (FetchBusinessPartnerFeatureParam) 
Feature(s) to be excluded during the fetch business partner:


    

  • FETCH_RECORD - Allows to switch fetching record field to reduce data size. By default turned on.
    • 

  • FETCH_RELATIONS - Allows to switch fetching relations of Business Partners. By default turned off. Only for storages with RELATIONS feature enabled
    • 



Items Enum: "FETCH_RECORD" "FETCH_RELATIONS"  
featureOn
Array of strings (FetchBusinessPartnerFeatureParam) 
Feature(s) to be used during the fetch business partner:


    

  • FETCH_RECORD - Allows to switch fetching record field to reduce data size. By default turned on.
    • 

  • FETCH_RELATIONS - Allows to switch fetching relations of Business Partners. By default turned off. Only for storages with RELATIONS feature enabled
    • 



Items Enum: "FETCH_RECORD" "FETCH_RELATIONS"  
limit
integer <int32>   [ 1 .. 10 ] 
 Default:  1
Number of items to be returned on the page.


 
 Example:  limit=5
modifiedAfter
string
Return entries which were modified after given data. The given date should support ISO-8601 representation


 
 Example:  modifiedAfter=2020-07-06T12:14:03.204Z
modifiedBefore
string
Return entries which were modified before given data. The given date should support ISO-8601 representation


 
 Example:  modifiedBefore=2020-07-06T12:14:03.204Z
Responses 
200
OK


401
Unauthorized


403
Forbidden


get/v4/storages/{storageId}/businesspartners/random
Request samples 
Response samples 
application/json
{
  • "limit": 0,
  • "values": [
    ]
}
Read Business Partner
SecurityapiKey 
Request 
path Parameters
id
required
string
id


 
storageId
required
string
storageId


 
query Parameters
featureOff
Array of strings (ReadBusinessPartnerFeatureParam) 
Feature(s) to be used during the read business partner:


    

  • APPLY_CURATION_DECISIONS - Applies curation decisions from Decision Log to business partner if any decisions found. By default turned off.
    • 

  • FETCH_RECORD - Allows to switch fetching record field to reduce data size. By default turned on.
    • 

  • FETCH_RELATIONS - Allows to switch fetching relations of Business Partners. By default turned off. Only for storages with RELATIONS feature enabled
    • 



Items Enum: "APPLY_CURATION_DECISIONS" "FETCH_RECORD" "FETCH_RELATIONS"  
featureOn
Array of strings (ReadBusinessPartnerFeatureParam) 
Feature(s) to be used during the read business partner:


    

  • APPLY_CURATION_DECISIONS - Applies curation decisions from Decision Log to business partner if any decisions found. By default turned off.
    • 

  • FETCH_RECORD - Allows to switch fetching record field to reduce data size. By default turned on.
    • 

  • FETCH_RELATIONS - Allows to switch fetching relations of Business Partners. By default turned off. Only for storages with RELATIONS feature enabled
    • 



Items Enum: "APPLY_CURATION_DECISIONS" "FETCH_RECORD" "FETCH_RELATIONS"  
Responses 
200
OK


get/v4/storages/{storageId}/businesspartners/{id}
Request samples 
Response samples 
application/json
{
  • "id": "63e635235c06b7396330fe40",
  • "createdAt": "string",
  • "lastModifiedAt": "string",
  • "externalId": "The ID managed in the customer's SAP systems.",
  • "dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
  • "disclosed": false,
  • "updateMonitoring": true,
  • "updateCommercialMonitoring": [
    ],
  • "metadata": {
    },
  • "record": "string",
  • "additionalInformation": [
    ],
  • "names": [],
  • "legalForm": {},
  • "identifiers": [],
  • "categories": [],
  • "status": {},
  • "profile": {
    },
  • "relations": [
    ],
  • "types": [],
  • "addresses": [
    ],
  • "bankAccounts": [
    ],
  • "externalContext": {
    }
}
Read Business Partners WSDL 
SecurityapiKey 
Request 
path Parameters
storageId
required
string
storageId


 
query Parameters
businessPartnerId
Array of strings
Business Partner IDs which should be filtered.


 
countryCode
Array of strings
Country short names used to filter the result of business partners returned.


 
curationLogResultStatus
Array of strings (CurationLevelParam) 
Curation log of curation result.


Items Enum: "LEVEL_1" "LEVEL_2" "LEVEL_3" "LEVEL_4" "LEVEL_5" "LEVEL_6" "UNKNOWN"  
dataSource
Array of strings
Data source (names or IDs) used to filter the result of business partners returned.


 
externalId
Array of strings
Business Partner externalIDs which should be filtered.


 
featuresOff
Array of strings (BusinessPartnersReadFeatureParam) 
Features to be turned off:


    

  • APPLY_CURATION_DECISIONS - Applies curation decisions from Decision Log to business partners if any decisions found. By default turned off.
    • 

  • CURATION_LOG_RESULT_STATUSES - Applies filters only to fields specific for curation results for filters: date, logResultTriggerType, logResultTriggerProvenanceTechnicalKeys. By default turned off.
    • 

  • FETCH_RECORD - Allows to switch fetching record field to reduce data size. By default turned on.
    • 

  • FETCH_RELATIONS - Allows to switch fetching relations of Business Partners. By default turned off. Only for storages with RELATIONS feature enabled.
    • 

  • NUMBER_OF_TOTAL - Allows to switch fetching the total number of Business Partners to improve performance. By default turned on.
    • 

  • USE_NEXT_START_AFTER - Allows to automatically calculate pagination indicator in nextStartAfter field. By default turned off.
    • 



Items Enum: "APPLY_CURATION_DECISIONS" "CURATION_LOG_RESULT_STATUSES" "FETCH_RECORD" "FETCH_RELATIONS" "NUMBER_OF_TOTAL" "USE_NEXT_START_AFTER"  
featuresOn
Array of strings (BusinessPartnersReadFeatureParam) 
Features to be turned on:


    

  • APPLY_CURATION_DECISIONS - Applies curation decisions from Decision Log to business partners if any decisions found. By default turned off.
    • 

  • CURATION_LOG_RESULT_STATUSES - Applies date filters only to fields specific for curation results. By default turned off.
    • 

  • FETCH_RECORD - Allows to switch fetching record field to reduce data size. By default turned on.
    • 

  • FETCH_RELATIONS - Allows to switch fetching relations of Business Partners. By default turned off. Only for storages with RELATIONS feature enabled.
    • 

  • NUMBER_OF_TOTAL - Allows to switch fetching the total number of Business Partners to improve performance. By default turned on.
    • 

  • USE_NEXT_START_AFTER - Allows to automatically calculate pagination indicator in nextStartAfter field. By default turned off.
    • 



Items Enum: "APPLY_CURATION_DECISIONS" "CURATION_LOG_RESULT_STATUSES" "FETCH_RECORD" "FETCH_RELATIONS" "NUMBER_OF_TOTAL" "USE_NEXT_START_AFTER"  
fromJobProcessedAt
string
Returns the results which have one of the log result status -> jobProcessedAt after given date. The given date should support ISO-8601 representation.


 
 Example:  fromJobProcessedAt=2022-04-04T12:44:03.240Z
fromProcessedAt
string
Returns the results which have one of the log result status -> processedAt after given date. The given date should support ISO-8601 representation.


 
 Example:  fromProcessedAt=2022-04-04T12:44:03.240Z
fromTriggerProcessedAt
string
Returns the results which have one of the log result status -> triggerProcessedAt after given date. The given date should support ISO-8601 representation.


 
 Example:  fromTriggerProcessedAt=2022-04-04T12:44:03.240Z
hasRawData
boolean
 Default:  false
Flag to filter result of business partners based on the existence of the record attribute (raw data).


 
limit
integer <int32>   >= 1 
 Default:  500
Number of items to be returned on the page.


 
 Example:  limit=100
logResultTriggerProvenanceTechnicalKeys
Array of strings (ProvenanceTechnicalKey) 
Provenance technical keys used for filtering the result which should match with at least one of any log result status -> triggerType fields.


 
 Example:  logResultTriggerProvenanceTechnicalKeys=VIES
logResultTriggerType
Array of strings (ProcessingLogResultStatusTriggerTypeTechnicalKeyParam) 
Trigger type used for filtering the result which should match with at least one of any log result status -> triggerType fields.


Items Enum: "CREATED" "UPDATED" "REFERENCE_DATA_CHANGED" "REFRESHED" "JOB"  
modifiedAfter
string
Return entries which were modified after given data. The given date should support ISO-8601 representation


 
 Example:  modifiedAfter=2020-07-06T12:14:03.204Z
modifiedBefore
string
Return entries which were modified before given data. The given date should support ISO-8601 representation


 
 Example:  modifiedBefore=2020-07-06T12:14:03.204Z
reviewStatus
string (ReviewStatusParam) 
Review status used for filtering the result data.


 Enum: "REVIEWED" "NOT_REVIEWED"  
sharingStatus
Array of strings
Business Partner Sharing Status which should be filtered.


Sharing Statuses which can be filtered out:


    

  • UNDER_CONSIDERATION
    • 

  • UNDISCLOSED_RECORD
    • 

  • MISSING_INFORMATION_FOR_LINKAGE
    • 

  • ERRONEOUS_INFORMATION_FOR_LINKAGE
    • 

  • ERRONEOUS_RECORD
    • 

  • PENDING_LINKAGE_DECISION
    • 

  • PROCESS_ISSUE
    • 

  • SHARED_WITH_NO_MATCH
    • 

  • SHARED_WITH_CONFIDENT_MATCH
    • 

  • SHARED_WITH_NO_MATCH_BY_REVIEW
    • 

  • SHARED_BY_REVIEW
    • 



 
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.


 
 Example:  startAfter=10
tagTypeTechnicalKey
string (TagTypeTechnicalKey) 
Type Technical Key of tags that are provided in 'tagValues' query param.


 
 Example:  tagTypeTechnicalKey=WAREHOUSE
tagValues
Array of strings (TagValue) 
Tag values that will be used to filter Business Partners. Values are connected with logical 'AND'.


 
 Example:  tagValues=Warehouse
toJobProcessedAt
string
Returns the results which have one of the log result status -> jobProcessedAt before given date. The given date should support ISO-8601 representation.


 
 Example:  toJobProcessedAt=2022-04-04T12:44:03.240Z
toProcessedAt
string
Returns the results which have one of the log result status -> processedAt before given date. The given date should support ISO-8601 representation.


 
 Example:  toProcessedAt=2022-04-04T12:44:03.240Z
toTriggerProcessedAt
string
Returns the results which have one of the log result status -> triggerProcessedAt before given date. The given date should support ISO-8601 representation.


 
 Example:  toTriggerProcessedAt=2022-04-04T12:44:03.240Z
typeTechnicalKeys
Array of strings (BusinessPartnerTypeTechnicalKeyParam)   <= 1 items 
Business Partner type technical keys which should be filtered.


Items Enum: "BP_ADDRESS" "LEGAL_ENTITY" "ORGANIZATIONAL_UNIT" "UNKNOWN" "BRAND"  
updateMonitoring
boolean
Flag to filter business partners by the value of updateMonitoring attribute


 
validationLogResultStatus
Array of strings (ValidationLevelParam) 
Violation level of validation result.


Items Enum: "OK" "ERROR" "WARNING" "INFO" "UNKNOWN"  
validationSharingLogResultStatus
Array of strings (ValidationLevelParam) 
Violation level of sharing validation result.


Items Enum: "OK" "ERROR" "WARNING" "INFO" "UNKNOWN"  
Responses 
200
OK


400
Bad Request


401
Unauthorized


get/v4/storages/{storageId}/businesspartners
Request samples 
Response samples 
application/json
{
  • "startAfter": "string",
  • "limit": 0,
  • "total": 0,
  • "values": [
    ],
  • "nextStartAfter": "string"
}
Read Business Partners Updates
Example Response:


{
  "values": [
    {
      "businessPartner": {
        "id": "123456",
        "externalId": "EXTID-86",
        ...,
        "record": "{<JSON>}"
      },
      "provenances": [
        {
          "name": "Supplier Gateway",
          "technicalKey": "SGW"
        }
      ],
      "changeSet": [
        {
          "modifiedAt": "2007-08-31T16:47",
          "propertyChanges": [
            {
              "newContent": "AAB",
              "previousContent": "XYZ",
              "changeType": "MODIFIED",
              "changeClassification": "MAJOR",
              "provenance": {
                "name": "Supplier Gateway",
                "technicalKey": "SGW"
              },
              "property": {
                "name": "Minority Indicator Value",
                "contentSelector": "$.profile.minorityIndicator.value",
                "technicalKey": "MINORITY_INDICATOR_VALUE"
                "parentConcept": {
                  "name": "Minority Indicator",
                  "technicalKey": "MINORITY_INDICATOR"
                }
              }
            }
          ],
          "provenances": [
            {
              "name": "Supplier Gateway",
              "technicalKey": "SGW"
            }
          ]
        }
      ]
    }
  ]
}



In typed concepts, like Name, Identifier or Premise, type.technicalKey and any non-empty property are required to be filled in order to monitor updates.


The following limits for updates calculated per concepts is applied:


    

  • $.addresses.administrativeAreas: up to 5 sub concept levels supported
    • 

  • $.addresses.localities: up to 5 sub concept levels supported
    • 

  • $.addresses.postCodes: up to 3 sub concepts supported
    • 

  • $.addresses.postalDeliveryPoints: up to 3 sub concepts supported
    • 

  • $.addresses.thoroughfares: up to 3 sub concepts supported
    • 

  • $.addresses.premises: up to 6 sub concepts supported
    • 



SecurityapiKey 
Request 
path Parameters
storageId
required
string
storageId


 
query Parameters
affectedConcepts
Array of strings (BusinessPartnerConceptParam) 
Only show updates which affected these concepts


Items Enum: "NAME" "IDENTIFIER" "LEGAL_FORM" "MINORITY_INDICATOR" "STATUS" "ADDRESS" "COUNTRY" "ADMINISTRATIVE_AREA" "POST_CODE" "LOCALITY" "THOROUGHFARE" "PREMISE" "POSTAL_DELIVERY_POINT" "GEO_COORDINATES" "GEOGRAPHIC_COORDINATES"  
 Example:  affectedConcepts=MINORITY_INDICATOR
affectedProperties
Array of strings (BusinessPartnerPropertyParam) 
Only show updates which affected these properties


Items Enum: "NAME_VALUE" "IDENTIFIER_VALUE" "MINORITY_INDICATOR_VALUE" "ADMINISTRATIVE_AREA_VALUE" "LOCALITY_VALUE" "POST_CODE_VALUE" "THOROUGHFARE_VALUE" "THOROUGHFARE_NUMBER" "BUSINESS_PARTNER_STATUS_TYPE" "LEGAL_FORM_NAME" "RECORD"  
 Example:  affectedProperties=MINORITY_INDICATOR_VALUE
businessPartnerIds
Array of strings  <= 500 items 
Only show updates for listed business partner IDs.
When providing list of business partner IDs, limit is ignored to provide full page.


 
changeClassification
string (PropertyChangeClassificationParam) 
Filter for change classifications


 Enum: "UNMODIFIED" "TRIVIAL" "MINOR" "MAJOR" "REJECTED"  
changeType
string
Filter for change types.


 Enum: "ADDED" "MODIFIED" "DELETED"  
 Example:  changeType=ADDED
countryShortName
Array of strings
Filter for countries.


 
 Example:  countryShortName=CH
dataSource
Array of strings
Filter for a data source (name or id).


 
 Example:  dataSource=VIES
exceptProvenanceTechnicalKeys
Array of strings (ProvenanceTechnicalKey) 
Show updates for all provenances except provided by technical keys. By default includes ORGANIZATION if not present on provenanceTechnicalKeys list.


 
 Example:  exceptProvenanceTechnicalKeys=VIES
featuresOff
Array of strings (BusinessPartnerUpdatesFeatureParam) 
Features to be used during the read business partners updates:


    

  • SHOW_BUSINESS_PARTNER - Show business partner merged out of updates in $.values[*].businessPartner. By default turned off.
    • 

  • FETCH_STORAGE_BUSINESS_PARTNER - Fetch business partner from a storage and set in $.values[*].storageBusinessPartner. By default turned off.
    • 

  • APPLY_CURATION_DECISIONS - Applies curation decisions from Decision Log to business partners in $.values[*].storageBusinessPartner if any decisions found. Requires FETCH_STORAGE_BUSINESS_PARTNER feature. By default turned off.
    • 

  • NUMBER_OF_TOTAL - Allows to switch fetching the total number of records to improve performance. By default turned on.
    • 



Items Enum: "APPLY_CURATION_DECISIONS" "FETCH_STORAGE_BUSINESS_PARTNER" "SHOW_BUSINESS_PARTNER"  
featuresOn
Array of strings (BusinessPartnerUpdatesFeatureParam) 
Features to be used during the read business partners updates:


    

  • SHOW_BUSINESS_PARTNER - Show businss partner merged out of updates in `$.values[*].businessPartner. By default turned off.
    • 

  • FETCH_STORAGE_BUSINESS_PARTNER - Fetch business partner from a storage and set in $.values[*].storageBusinessPartner. By default turned off.
    • 

  • APPLY_CURATION_DECISIONS - Applies curation decisions from Decision Log to business partners in $.values[*].storageBusinessPartner if any decisions found. Requires FETCH_STORAGE_BUSINESS_PARTNER feature. By default turned off.
    • 

  • NUMBER_OF_TOTAL - Allows to switch fetching the total number of records to improve performance. By default turned on.
    • 



Items Enum: "APPLY_CURATION_DECISIONS" "FETCH_STORAGE_BUSINESS_PARTNER" "SHOW_BUSINESS_PARTNER"  
from
string
Only show updates which have been modified after this date (ISO 8601). Default is to show the 'last seven days' and farthest in the past is 'since three month'


 
 Example:  from=2019-12-31T16:47
limit
integer <int32>   >= 1 
 Default:  500
Number of items to be returned on the page.


 
 Example:  limit=100
provenanceTechnicalKeys
Array of strings (ProvenanceTechnicalKey) 
Show updates for selected provenances by technical keys


 
 Example:  provenanceTechnicalKeys=VIES
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.


 
 Example:  startAfter=10
Responses 
200
OK


get/v4/storages/{storageId}/businesspartners/updates
Request samples 
Response samples 
application/json
{
  • "limit": 0,
  • "total": 0,
  • "startAfter": "string",
  • "nextStartAfter": "string",
  • "values": [
    ]
}
Start Toggle Update Monitoring Job
To toggle update monitoring on multiple BusinessPartners, the permission can be changed in two ways:


    

  1. A complete Data Source identified by the parameter 'dataSourceId'
    2. 

  2. Or for a certain Country of a Data Source. This requires both parameters 'dataSourceId' and 'countryShortName' to be set
    3. 



After the job is finished, the following actions are taken for business partners which match the dataSourceId and countryShortName criteria:


    

  • businessPartner.updateMonitoring fields takes a value of ToggleUpdateMonitoringJobRequest#enable
    • 

  • if enable is true then:

    • 

  • if enable is false then:
      

    • all existing links of a business partner to business partners in non-commercial reference data sources are removed
      • 

    • updates are no more propagated for this business partner
      • 

    • linkage is not performed for any non-commercial reference data source
      • 

    

    • 



For toggling via a list of Business Partners, identified by their ID, please go to Toggle Update Monitoring of Business Partners.


SecurityapiKey 
Request 
Request Body schema: application/json
required
countryShortName
string (CountryShortName) 
Country code (ISO 3166-1 alpha-2).


 
dataSourceId
required
string (BusinessPartnerStorageDataSourceId) 
Unique identifier for a Data Source of the Storage.


 
description
string (JobDescription) 
Detailed description of a Job.


 
enable
required
boolean (ToggleUpdateMonitoringRequestEnable) 
Parameter to describe if the Business Partners should be enabled for update monitoring (true) or disabled (false) for non-commercial reference data sources.


 
name
string (JobName) 
Name of a Job.


 
storageId
required
string (BusinessPartnerStorageId) 
Unique identifier of the Storage.


 
Responses 
200
OK


400
The sent request is malformed.


post/jobs/toggleUpdateMonitoringJobs
Request samples 
application/json
{
  • "enable": true,
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "name": "Process vendor data.",
  • "description": "I started this job to improve quality of our data.",
  • "dataSourceId": "648824a691d8d2503d65103e",
  • "countryShortName": "CH"
}
Response samples 
application/json
{
  • "id": "string",
  • "createdBy": "string",
  • "createdAt": "string",
  • "modifiedAt": "string",
  • "progress": 0,
  • "status": "RUNNING",
  • "statusMessage": "string",
  • "enable": true,
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "dataSourceId": "648824a691d8d2503d65103e",
  • "countryShortName": "CH"
}
Toggle Update Monitoring of Business Partners
To toggle update monitoring on multiple BusinessPartners, the permission can be changed
via a list of Business Partners, identified by their ID.


After the job is finished, the following actions are taken for business partners which match the businessPartnerIds criteria:


    

  • businessPartner.updateMonitoring fields takes a value of ToggleUpdateMonitoringJobRequest#enable
    • 

  • if enable is true then:

    • 

  • if enable is false then:
      

    • all existing links of a business partner to business partners in non-commercial reference data sources are removed
      • 

    • updates are no more propagated for this business partner
      • 

    • linkage is not performed for any non-commercial reference data source
      • 

    

    • 



For toggling a complete Data Source or for a certain Country of a Data Source,
please go to Start Toggle Update Monitoring Job.


SecurityapiKey 
Request 
path Parameters
storageId
required
string
storageId


 
Request Body schema: application/json
required
businessPartnerIds
required
Array of strings  [ 1 .. 1000 ] items 
List of Business Partner IDs to identify all those Business Partners that should be enabled/disabled.


 
enable
required
boolean (ToggleUpdateMonitoringRequestEnable) 
Parameter to describe if the Business Partners should be enabled for update monitoring (true) or disabled (false) for non-commercial reference data sources.


 
Responses 
204
OK


put/storages/{storageId}/businesspartners/toggleUpdateMonitoring
Request samples 
application/json
{
  • "enable": true,
  • "businessPartnerIds": [
    ]
}
Update Disclosure
To un-/disclose multiple BusinessPartners, the disclosure can be changed in three ways:


    

  1. A complete data source identified by the parameter 'dataSourceId' (deprecated - use Sharing Scopes instead. Still applicable, but can be overwritten by Sharing Scopes)
    2. 

  2. Or for a certain country of a data source. This requires both parameters 'dataSourceId' and 'countryCode' to be set (deprecated - use Sharing Scopes instead. Still applicable, but can be overwritten by Sharing Scopes)
    3. 

  3. Or a list of business partners, identified by their ID. The other parameters should be left empty. Note: disclosure set via business partner ID can be overwritten by creation or deletion of a Sharing Scope.
    4. 



Any other combination may result in a Bad Reqeust.


For more details, you can read about Sharing Scopes.


SecurityapiKey 
Request 
path Parameters
storageId
required
string
storageId


 
Request Body schema: application/json
required
businessPartnerIds
Array of strings  non-empty 
List of BusinessPartner IDs to identify all those BusinessPartners that should be un-/disclose.