Seed Updates

Poll Seed Updates Generate Job

Poll a Seed Updates Generate Job for the given storage.

SecurityapiKey
Request
path Parameters
jobId
required
string (JobId)

ID of the job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de
storageId
required
string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
Responses
200

OK

400

Bad Request

get/v5/storages/{storageId}/seedupdates/generate/{jobId}
Request samples
Response samples
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "name": "Process vendor data.",
  • "description": "I started this job to improve quality of our data.",
  • "progress": "77",
  • "status": "RUNNING",
  • "statusMessage": "The job failed because storage is empty.",
  • "createdBy": "76248934691294444",
  • "createdAt": "2024-09-16T14:59:33Z",
  • "modifiedAt": "2024-09-16T14:59:33Z",
  • "referenceDataSource": "BR_RF",
  • "dataSourceIds": [
    ],
  • "externalIds": [
    ],
  • "businessPartnerIds": [
    ],
  • "countryShortName": "CH"
}

Start Seed Updates Generate Job

Start a Seed Updates Generate Job for the given storage.

SecurityapiKey
Request
path Parameters
storageId
required
string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
Request Body schema: application/json
required
businessPartnerIds
Array of strings (BusinessPartnerIds)

List of business partner IDs to be processed.

Example: ["63e635235c06b7396330fe40"]
countryShortName
string (CountryShortName)

Country code (ISO 3166-1 alpha-2).

Example: "CH"
dataSourceIds
Array of strings (StorageDataSourceIds)

List of data source IDs to be processed.

Example: ["5e2874fb8d2a7400011acee1"]
externalIds
Array of strings (BusinessPartnerExternalIds)

List of business partner external IDs to be processed.

Example: ["The ID managed in the customer's SAP systems."]
referenceDataSource
required
string (DataSourceTechnicalKey)

Technical key of the data source.

Example: "BR_RF"
Responses
200

OK

400

Bad Request

post/v5/storages/{storageId}/seedupdates/generate
Request samples
application/json
{
  • "referenceDataSource": "BR_RF",
  • "dataSourceIds": [
    ],
  • "externalIds": [
    ],
  • "businessPartnerIds": [
    ],
  • "countryShortName": "CH"
}
Response samples
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "name": "Process vendor data.",
  • "description": "I started this job to improve quality of our data.",
  • "progress": "77",
  • "status": "RUNNING",
  • "statusMessage": "The job failed because storage is empty.",
  • "createdBy": "76248934691294444",
  • "createdAt": "2024-09-16T14:59:33Z",
  • "modifiedAt": "2024-09-16T14:59:33Z",
  • "referenceDataSource": "BR_RF",
  • "dataSourceIds": [
    ],
  • "externalIds": [
    ],
  • "businessPartnerIds": [
    ],
  • "countryShortName": "CH"
}