Reserve the next golden record tasks waiting in the given step queue

Version: 24.08

Reserve the next golden record tasks waiting in the given step queue

Reserve up to a given number of golden record tasks in the given step queue. The response entries contain the business partner data to process which consists of the generic and L/S/A data. The reservation has a time limit which is returned. For a single request, the maximum number of reservable tasks is limited to 100.

application/json

Request Body required

amount int32 required
The maximum number of tasks to reserve. Can be fewer if queue is not full enough.
step string required
Possible values: [CleanAndSync, PoolSync, Clean]
The step queue to reserve from

Responses

The reserved tasks with their business partner data to process.

application/json

Schema
Example (from schema)

Schema

reservedTasks object[]
The reserved tasks with their business partner data to process
taskId string
The identifier of the reserved task
recordId string
The identifier of the gate record for which this task has been created
businessPartner object
The business partner data to be processed
nameParts object[]
name string
type string
Possible values: [LegalName, ShortName, LegalForm, SiteName, AddressName]
owningCompany string
uncategorized object
nameParts string[]
identifiers object[]
value string
type string
issuingBody string
states object[]
validFrom date-time
validTo date-time
type string
Possible values: [ACTIVE, INACTIVE]
address object
bpnReference object
referenceValue string
desiredBpn string
referenceType string
Possible values: [Bpn, BpnRequestIdentifier]
addressName string
identifiers object[]
value string
type string
issuingBody string
states object[]
validFrom date-time
validTo date-time
type string
Possible values: [ACTIVE, INACTIVE]
confidenceCriteria object
sharedByOwner boolean
checkedByExternalDataSource boolean
numberOfSharingMembers int32
lastConfidenceCheckAt date-time
nextConfidenceCheckAt date-time
confidenceLevel int32
physicalAddress object
geographicCoordinates object
longitude float
latitude float
altitude float
country string
administrativeAreaLevel1 string
administrativeAreaLevel2 string
administrativeAreaLevel3 string
postalCode string
city string
district string
street object
name string
houseNumber string
houseNumberSupplement string
milestone string
direction string
namePrefix string
additionalNamePrefix string
nameSuffix string
additionalNameSuffix string
companyPostalCode string
industrialZone string
building string
floor string
door string
taxJurisdictionCode string
alternativeAddress object
geographicCoordinates object
longitude float
latitude float
altitude float
country string
administrativeAreaLevel1 string
postalCode string
city string
deliveryServiceType string
Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]
deliveryServiceQualifier string
deliveryServiceNumber string
hasChanged boolean
legalEntity object
bpnReference object
referenceValue string
desiredBpn string
referenceType string
Possible values: [Bpn, BpnRequestIdentifier]
legalName string
legalShortName string
legalForm string
identifiers object[]
value string
type string
issuingBody string
states object[]
validFrom date-time
validTo date-time
type string
Possible values: [ACTIVE, INACTIVE]
confidenceCriteria object
sharedByOwner boolean
checkedByExternalDataSource boolean
numberOfSharingMembers int32
lastConfidenceCheckAt date-time
nextConfidenceCheckAt date-time
confidenceLevel int32
isCatenaXMemberData boolean
hasChanged boolean
legalAddress object
bpnReference object
referenceValue string
desiredBpn string
referenceType string
Possible values: [Bpn, BpnRequestIdentifier]
addressName string
identifiers object[]
value string
type string
issuingBody string
states object[]
validFrom date-time
validTo date-time
type string
Possible values: [ACTIVE, INACTIVE]
confidenceCriteria object
sharedByOwner boolean
checkedByExternalDataSource boolean
numberOfSharingMembers int32
lastConfidenceCheckAt date-time
nextConfidenceCheckAt date-time
confidenceLevel int32
physicalAddress object
geographicCoordinates object
longitude float
latitude float
altitude float
country string
administrativeAreaLevel1 string
administrativeAreaLevel2 string
administrativeAreaLevel3 string
postalCode string
city string
district string
street object
name string
houseNumber string
houseNumberSupplement string
milestone string
direction string
namePrefix string
additionalNamePrefix string
nameSuffix string
additionalNameSuffix string
companyPostalCode string
industrialZone string
building string
floor string
door string
taxJurisdictionCode string
alternativeAddress object
geographicCoordinates object
longitude float
latitude float
altitude float
country string
administrativeAreaLevel1 string
postalCode string
city string
deliveryServiceType string
Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]
deliveryServiceQualifier string
deliveryServiceNumber string
hasChanged boolean
site object
bpnReference object
referenceValue string
desiredBpn string
referenceType string
Possible values: [Bpn, BpnRequestIdentifier]
siteName string
states object[]
validFrom date-time
validTo date-time
type string
Possible values: [ACTIVE, INACTIVE]
confidenceCriteria object
sharedByOwner boolean
checkedByExternalDataSource boolean
numberOfSharingMembers int32
lastConfidenceCheckAt date-time
nextConfidenceCheckAt date-time
confidenceLevel int32
hasChanged boolean
siteMainAddress object
bpnReference object
referenceValue string
desiredBpn string
referenceType string
Possible values: [Bpn, BpnRequestIdentifier]
addressName string
identifiers object[]
value string
type string
issuingBody string
states object[]
validFrom date-time
validTo date-time
type string
Possible values: [ACTIVE, INACTIVE]
confidenceCriteria object
sharedByOwner boolean
checkedByExternalDataSource boolean
numberOfSharingMembers int32
lastConfidenceCheckAt date-time
nextConfidenceCheckAt date-time
confidenceLevel int32
physicalAddress object
geographicCoordinates object
longitude float
latitude float
altitude float
country string
administrativeAreaLevel1 string
administrativeAreaLevel2 string
administrativeAreaLevel3 string
postalCode string
city string
district string
street object
name string
houseNumber string
houseNumberSupplement string
milestone string
direction string
namePrefix string
additionalNamePrefix string
nameSuffix string
additionalNameSuffix string
companyPostalCode string
industrialZone string
building string
floor string
door string
taxJurisdictionCode string
alternativeAddress object
geographicCoordinates object
longitude float
latitude float
altitude float
country string
administrativeAreaLevel1 string
postalCode string
city string
deliveryServiceType string
Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]
deliveryServiceQualifier string
deliveryServiceNumber string
hasChanged boolean
siteMainIsLegalAddress boolean
additionalAddress object
bpnReference object
referenceValue string
desiredBpn string
referenceType string
Possible values: [Bpn, BpnRequestIdentifier]
addressName string
identifiers object[]
value string
type string
issuingBody string
states object[]
validFrom date-time
validTo date-time
type string
Possible values: [ACTIVE, INACTIVE]
confidenceCriteria object
sharedByOwner boolean
checkedByExternalDataSource boolean
numberOfSharingMembers int32
lastConfidenceCheckAt date-time
nextConfidenceCheckAt date-time
confidenceLevel int32
physicalAddress object
geographicCoordinates object
longitude float
latitude float
altitude float
country string
administrativeAreaLevel1 string
administrativeAreaLevel2 string
administrativeAreaLevel3 string
postalCode string
city string
district string
street object
name string
houseNumber string
houseNumberSupplement string
milestone string
direction string
namePrefix string
additionalNamePrefix string
nameSuffix string
additionalNameSuffix string
companyPostalCode string
industrialZone string
building string
floor string
door string
taxJurisdictionCode string
alternativeAddress object
geographicCoordinates object
longitude float
latitude float
altitude float
country string
administrativeAreaLevel1 string
postalCode string
city string
deliveryServiceType string
Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]
deliveryServiceQualifier string
deliveryServiceNumber string
hasChanged boolean
type string
Possible values: [LegalEntity, Site, Address]
requestKey string
timeout date-time deprecated
The timestamp until the reservation is valid and results are accepted

{
  "reservedTasks": [
    {
      "taskId": "string",
      "recordId": "string",
      "businessPartner": {
        "nameParts": [
          {
            "name": "string",
            "type": "LegalName"
          }
        ],
        "owningCompany": "string",
        "uncategorized": {
          "nameParts": [
            "string"
          ],
          "identifiers": [
            {
              "value": "string",
              "type": "string",
              "issuingBody": "string"
            }
          ],
          "states": [
            {
              "validFrom": "2024-07-15",
              "validTo": "2024-07-15",
              "type": "ACTIVE"
            }
          ],
          "address": {
            "bpnReference": {
              "referenceValue": "string",
              "desiredBpn": "string",
              "referenceType": "Bpn"
            },
            "addressName": "string",
            "identifiers": [
              {
                "value": "string",
                "type": "string",
                "issuingBody": "string"
              }
            ],
            "states": [
              {
                "validFrom": "2024-07-15",
                "validTo": "2024-07-15",
                "type": "ACTIVE"
              }
            ],
            "confidenceCriteria": {
              "sharedByOwner": true,
              "checkedByExternalDataSource": true,
              "numberOfSharingMembers": 0,
              "lastConfidenceCheckAt": "2024-07-15",
              "nextConfidenceCheckAt": "2024-07-15",
              "confidenceLevel": 0
            },
            "physicalAddress": {
              "geographicCoordinates": {
                "longitude": 0,
                "latitude": 0,
                "altitude": 0
              },
              "country": "string",
              "administrativeAreaLevel1": "string",
              "administrativeAreaLevel2": "string",
              "administrativeAreaLevel3": "string",
              "postalCode": "string",
              "city": "string",
              "district": "string",
              "street": {
                "name": "string",
                "houseNumber": "string",
                "houseNumberSupplement": "string",
                "milestone": "string",
                "direction": "string",
                "namePrefix": "string",
                "additionalNamePrefix": "string",
                "nameSuffix": "string",
                "additionalNameSuffix": "string"
              },
              "companyPostalCode": "string",
              "industrialZone": "string",
              "building": "string",
              "floor": "string",
              "door": "string",
              "taxJurisdictionCode": "string"
            },
            "alternativeAddress": {
              "geographicCoordinates": {
                "longitude": 0,
                "latitude": 0,
                "altitude": 0
              },
              "country": "string",
              "administrativeAreaLevel1": "string",
              "postalCode": "string",
              "city": "string",
              "deliveryServiceType": "PO_BOX",
              "deliveryServiceQualifier": "string",
              "deliveryServiceNumber": "string"
            },
            "hasChanged": true
          }
        },
        "legalEntity": {
          "bpnReference": {
            "referenceValue": "string",
            "desiredBpn": "string",
            "referenceType": "Bpn"
          },
          "legalName": "string",
          "legalShortName": "string",
          "legalForm": "string",
          "identifiers": [
            {
              "value": "string",
              "type": "string",
              "issuingBody": "string"
            }
          ],
          "states": [
            {
              "validFrom": "2024-07-15",
              "validTo": "2024-07-15",
              "type": "ACTIVE"
            }
          ],
          "confidenceCriteria": {
            "sharedByOwner": true,
            "checkedByExternalDataSource": true,
            "numberOfSharingMembers": 0,
            "lastConfidenceCheckAt": "2024-07-15",
            "nextConfidenceCheckAt": "2024-07-15",
            "confidenceLevel": 0
          },
          "isCatenaXMemberData": true,
          "hasChanged": true,
          "legalAddress": {
            "bpnReference": {
              "referenceValue": "string",
              "desiredBpn": "string",
              "referenceType": "Bpn"
            },
            "addressName": "string",
            "identifiers": [
              {
                "value": "string",
                "type": "string",
                "issuingBody": "string"
              }
            ],
            "states": [
              {
                "validFrom": "2024-07-15",
                "validTo": "2024-07-15",
                "type": "ACTIVE"
              }
            ],
            "confidenceCriteria": {
              "sharedByOwner": true,
              "checkedByExternalDataSource": true,
              "numberOfSharingMembers": 0,
              "lastConfidenceCheckAt": "2024-07-15",
              "nextConfidenceCheckAt": "2024-07-15",
              "confidenceLevel": 0
            },
            "physicalAddress": {
              "geographicCoordinates": {
                "longitude": 0,
                "latitude": 0,
                "altitude": 0
              },
              "country": "string",
              "administrativeAreaLevel1": "string",
              "administrativeAreaLevel2": "string",
              "administrativeAreaLevel3": "string",
              "postalCode": "string",
              "city": "string",
              "district": "string",
              "street": {
                "name": "string",
                "houseNumber": "string",
                "houseNumberSupplement": "string",
                "milestone": "string",
                "direction": "string",
                "namePrefix": "string",
                "additionalNamePrefix": "string",
                "nameSuffix": "string",
                "additionalNameSuffix": "string"
              },
              "companyPostalCode": "string",
              "industrialZone": "string",
              "building": "string",
              "floor": "string",
              "door": "string",
              "taxJurisdictionCode": "string"
            },
            "alternativeAddress": {
              "geographicCoordinates": {
                "longitude": 0,
                "latitude": 0,
                "altitude": 0
              },
              "country": "string",
              "administrativeAreaLevel1": "string",
              "postalCode": "string",
              "city": "string",
              "deliveryServiceType": "PO_BOX",
              "deliveryServiceQualifier": "string",
              "deliveryServiceNumber": "string"
            },
            "hasChanged": true
          }
        },
        "site": {
          "bpnReference": {
            "referenceValue": "string",
            "desiredBpn": "string",
            "referenceType": "Bpn"
          },
          "siteName": "string",
          "states": [
            {
              "validFrom": "2024-07-15",
              "validTo": "2024-07-15",
              "type": "ACTIVE"
            }
          ],
          "confidenceCriteria": {
            "sharedByOwner": true,
            "checkedByExternalDataSource": true,
            "numberOfSharingMembers": 0,
            "lastConfidenceCheckAt": "2024-07-15",
            "nextConfidenceCheckAt": "2024-07-15",
            "confidenceLevel": 0
          },
          "hasChanged": true,
          "siteMainAddress": {
            "bpnReference": {
              "referenceValue": "string",
              "desiredBpn": "string",
              "referenceType": "Bpn"
            },
            "addressName": "string",
            "identifiers": [
              {
                "value": "string",
                "type": "string",
                "issuingBody": "string"
              }
            ],
            "states": [
              {
                "validFrom": "2024-07-15",
                "validTo": "2024-07-15",
                "type": "ACTIVE"
              }
            ],
            "confidenceCriteria": {
              "sharedByOwner": true,
              "checkedByExternalDataSource": true,
              "numberOfSharingMembers": 0,
              "lastConfidenceCheckAt": "2024-07-15",
              "nextConfidenceCheckAt": "2024-07-15",
              "confidenceLevel": 0
            },
            "physicalAddress": {
              "geographicCoordinates": {
                "longitude": 0,
                "latitude": 0,
                "altitude": 0
              },
              "country": "string",
              "administrativeAreaLevel1": "string",
              "administrativeAreaLevel2": "string",
              "administrativeAreaLevel3": "string",
              "postalCode": "string",
              "city": "string",
              "district": "string",
              "street": {
                "name": "string",
                "houseNumber": "string",
                "houseNumberSupplement": "string",
                "milestone": "string",
                "direction": "string",
                "namePrefix": "string",
                "additionalNamePrefix": "string",
                "nameSuffix": "string",
                "additionalNameSuffix": "string"
              },
              "companyPostalCode": "string",
              "industrialZone": "string",
              "building": "string",
              "floor": "string",
              "door": "string",
              "taxJurisdictionCode": "string"
            },
            "alternativeAddress": {
              "geographicCoordinates": {
                "longitude": 0,
                "latitude": 0,
                "altitude": 0
              },
              "country": "string",
              "administrativeAreaLevel1": "string",
              "postalCode": "string",
              "city": "string",
              "deliveryServiceType": "PO_BOX",
              "deliveryServiceQualifier": "string",
              "deliveryServiceNumber": "string"
            },
            "hasChanged": true
          },
          "siteMainIsLegalAddress": true
        },
        "additionalAddress": {
          "bpnReference": {
            "referenceValue": "string",
            "desiredBpn": "string",
            "referenceType": "Bpn"
          },
          "addressName": "string",
          "identifiers": [
            {
              "value": "string",
              "type": "string",
              "issuingBody": "string"
            }
          ],
          "states": [
            {
              "validFrom": "2024-07-15",
              "validTo": "2024-07-15",
              "type": "ACTIVE"
            }
          ],
          "confidenceCriteria": {
            "sharedByOwner": true,
            "checkedByExternalDataSource": true,
            "numberOfSharingMembers": 0,
            "lastConfidenceCheckAt": "2024-07-15",
            "nextConfidenceCheckAt": "2024-07-15",
            "confidenceLevel": 0
          },
          "physicalAddress": {
            "geographicCoordinates": {
              "longitude": 0,
              "latitude": 0,
              "altitude": 0
            },
            "country": "string",
            "administrativeAreaLevel1": "string",
            "administrativeAreaLevel2": "string",
            "administrativeAreaLevel3": "string",
            "postalCode": "string",
            "city": "string",
            "district": "string",
            "street": {
              "name": "string",
              "houseNumber": "string",
              "houseNumberSupplement": "string",
              "milestone": "string",
              "direction": "string",
              "namePrefix": "string",
              "additionalNamePrefix": "string",
              "nameSuffix": "string",
              "additionalNameSuffix": "string"
            },
            "companyPostalCode": "string",
            "industrialZone": "string",
            "building": "string",
            "floor": "string",
            "door": "string",
            "taxJurisdictionCode": "string"
          },
          "alternativeAddress": {
            "geographicCoordinates": {
              "longitude": 0,
              "latitude": 0,
              "altitude": 0
            },
            "country": "string",
            "administrativeAreaLevel1": "string",
            "postalCode": "string",
            "city": "string",
            "deliveryServiceType": "PO_BOX",
            "deliveryServiceQualifier": "string",
            "deliveryServiceNumber": "string"
          },
          "hasChanged": true
        },
        "type": "LegalEntity"
      },
      "requestKey": "string"
    }
  ]
}

Reserve the next golden record tasks waiting in the given step queue​

Reserve the next golden record tasks waiting in the given step queue