Search for the state of golden record tasks by task identifiers
Returns the state of golden record tasks based on the provided task identifiers. Unknown task identifiers are ignored.
- application/json
Request Body required
- taskIds string[] required
- 200
- 400
The state of the tasks for the provided task identifiers.
- application/json
- Schema
- Example (from schema)
Schema
tasks object[]
taskId stringbusinessPartnerResult object
Generic business partner with external id
nameParts string[]The list of name parts to accommodate the different number of name fields in different systems.
identifiers object[]
The list of identifiers of the business partner. Sorted and duplicates removed by the service.
type stringTechnical key of the type to which this identifier belongs to
value stringValue of the identifier
issuingBody stringBody which issued the identifier
states object[]
The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.
validFrom date-timeDate since when the status is/was valid.
validTo date-timeDate until the status was valid, if applicable.
type stringPossible values: [
ACTIVE
,INACTIVE
]The type of this specified status.
roles string[]Possible values: [
SUPPLIER
,CUSTOMER
,ONE_TIME_SUPPLIER
,ONE_TIME_CUSTOMER
]One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.
legalEntity object
The legal entity, on which the business partner provides a view.
legalEntityBpn stringThe BPNL of the legal entity, on which the business partner provides a view.
legalName stringThe name of the legal entity, on which the business partner provides a view, according to official registers.
shortName stringThe abbreviated name of the legal entity, on which the business partner provides a view.
legalForm stringThe legal form of the legal entity, on which the business partner provides a view.
classifications object[]
The list of classifications of the business partner, such as a specific industry. Sorted and duplicates removed by the service.
type stringPossible values: [
NACE
,NAF
,NAICS
,SIC
]Type of classification.
code stringThe identifier of the class belonging to the classification.
value stringThe name of the class belonging to the classification.
confidenceCriteria object
sharedByOwner booleancheckedByExternalDataSource booleannumberOfBusinessPartners int32lastConfidenceCheckAt date-timenextConfidenceCheckAt date-timeconfidenceLevel int32site object
The site, on which the business partner provides a view.
siteBpn stringThe BPNS of the site, on which the business partner provides a view.
name stringThe name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses.
confidenceCriteria object
sharedByOwner booleancheckedByExternalDataSource booleannumberOfBusinessPartners int32lastConfidenceCheckAt date-timenextConfidenceCheckAt date-timeconfidenceLevel int32address object
The address, on which the business partner provides a view.
addressBpn stringThe BPNA of the address, on which the business partner provides a view.
name stringThe name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance.
addressType stringPossible values: [
LegalAndSiteMainAddress
,LegalAddress
,SiteMainAddress
,AdditionalAddress
]One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address.
physicalPostalAddress object
The physical postal address of the address, on which the business partner provides a view, such as an office, warehouse, gate, etc.
geographicCoordinates object
The exact location of the physical postal address in latitude, longitude, and altitude.
longitude floatLongitude coordinate
latitude floatLatitude coordinate
altitude floatAltitude, if applicable
country stringPossible values: [
UNDEFINED
,AC
,AD
,AE
,AF
,AG
,AI
,AL
,AM
,AN
,AO
,AQ
,AR
,AS
,AT
,AU
,AW
,AX
,AZ
,BA
,BB
,BD
,BE
,BF
,BG
,BH
,BI
,BJ
,BL
,BM
,BN
,BO
,BQ
,BR
,BS
,BT
,BU
,BV
,BW
,BY
,BZ
,CA
,CC
,CD
,CF
,CG
,CH
,CI
,CK
,CL
,CM
,CN
,CO
,CP
,CR
,CS
,CU
,CV
,CW
,CX
,CY
,CZ
,DE
,DG
,DJ
,DK
,DM
,DO
,DZ
,EA
,EC
,EE
,EG
,EH
,ER
,ES
,ET
,EU
,EZ
,FI
,FJ
,FK
,FM
,FO
,FR
,FX
,GA
,GB
,GD
,GE
,GF
,GG
,GH
,GI
,GL
,GM
,GN
,GP
,GQ
,GR
,GS
,GT
,GU
,GW
,GY
,HK
,HM
,HN
,HR
,HT
,HU
,IC
,ID
,IE
,IL
,IM
,IN
,IO
,IQ
,IR
,IS
,IT
,JE
,JM
,JO
,JP
,KE
,KG
,KH
,KI
,KM
,KN
,KP
,KR
,KW
,KY
,KZ
,LA
,LB
,LC
,LI
,LK
,LR
,LS
,LT
,LU
,LV
,LY
,MA
,MC
,MD
,ME
,MF
,MG
,MH
,MK
,ML
,MM
,MN
,MO
,MP
,MQ
,MR
,MS
,MT
,MU
,MV
,MW
,MX
,MY
,MZ
,NA
,NC
,NE
,NF
,NG
,NI
,NL
,NO
,NP
,NR
,NT
,NU
,NZ
,OM
,PA
,PE
,PF
,PG
,PH
,PK
,PL
,PM
,PN
,PR
,PS
,PT
,PW
,PY
,QA
,RE
,RO
,RS
,RU
,RW
,SA
,SB
,SC
,SD
,SE
,SF
,SG
,SH
,SI
,SJ
,SK
,SL
,SM
,SN
,SO
,SR
,SS
,ST
,SU
,SV
,SX
,SY
,SZ
,TA
,TC
,TD
,TF
,TG
,TH
,TJ
,TK
,TL
,TM
,TN
,TO
,TP
,TR
,TT
,TV
,TW
,TZ
,UA
,UG
,UK
,UM
,US
,UY
,UZ
,VA
,VC
,VE
,VG
,VI
,VN
,VU
,WF
,WS
,XI
,XU
,XK
,YE
,YT
,YU
,ZA
,ZM
,ZR
,ZW
]The 2-digit country code of the physical postal address according to ISO 3166-1.
administrativeAreaLevel1 stringThe 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.
administrativeAreaLevel2 stringThe name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country.
administrativeAreaLevel3 stringThe name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country.
postalCode stringThe alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.
city stringThe name of the city of the physical postal address, synonyms: town, village, municipality.
district stringThe name of the district of the physical postal address which divides the city in several smaller areas.
street object
name stringThe name of the street.
houseNumber stringThe number representing the exact location of a building within the street.
houseNumberSupplement stringmilestone stringThe number representing the exact location of an addressed object within a street without house numbers, such as within long roads.
direction stringThe cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South.
namePrefix stringThe street related information, which is usually printed before the official street name on an address label.
additionalNamePrefix stringThe additional street related information, which is usually printed before the official street name on an address label.
nameSuffix stringThe street related information, which is usually printed after the official street name on an address label.
additionalNameSuffix stringThe additional street related information, which is usually printed after the official street name on an address label.
companyPostalCode stringThe company postal code of the physical postal address, which is sometimes required for large companies.
industrialZone stringThe industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area.
building stringThe alphanumeric identifier of the building addressed by the physical postal address.
floor stringThe number of a floor in the building addressed by the physical postal address, synonym: level.
door stringThe number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite.
alternativePostalAddress object
The alternative postal address of the address, on which the business partner provides a view, for example if the goods are to be picked up somewhere else.
geographicCoordinates object
The exact location of the physical postal address in latitude, longitude, and altitude.
longitude floatLongitude coordinate
latitude floatLatitude coordinate
altitude floatAltitude, if applicable
country stringPossible values: [
UNDEFINED
,AC
,AD
,AE
,AF
,AG
,AI
,AL
,AM
,AN
,AO
,AQ
,AR
,AS
,AT
,AU
,AW
,AX
,AZ
,BA
,BB
,BD
,BE
,BF
,BG
,BH
,BI
,BJ
,BL
,BM
,BN
,BO
,BQ
,BR
,BS
,BT
,BU
,BV
,BW
,BY
,BZ
,CA
,CC
,CD
,CF
,CG
,CH
,CI
,CK
,CL
,CM
,CN
,CO
,CP
,CR
,CS
,CU
,CV
,CW
,CX
,CY
,CZ
,DE
,DG
,DJ
,DK
,DM
,DO
,DZ
,EA
,EC
,EE
,EG
,EH
,ER
,ES
,ET
,EU
,EZ
,FI
,FJ
,FK
,FM
,FO
,FR
,FX
,GA
,GB
,GD
,GE
,GF
,GG
,GH
,GI
,GL
,GM
,GN
,GP
,GQ
,GR
,GS
,GT
,GU
,GW
,GY
,HK
,HM
,HN
,HR
,HT
,HU
,IC
,ID
,IE
,IL
,IM
,IN
,IO
,IQ
,IR
,IS
,IT
,JE
,JM
,JO
,JP
,KE
,KG
,KH
,KI
,KM
,KN
,KP
,KR
,KW
,KY
,KZ
,LA
,LB
,LC
,LI
,LK
,LR
,LS
,LT
,LU
,LV
,LY
,MA
,MC
,MD
,ME
,MF
,MG
,MH
,MK
,ML
,MM
,MN
,MO
,MP
,MQ
,MR
,MS
,MT
,MU
,MV
,MW
,MX
,MY
,MZ
,NA
,NC
,NE
,NF
,NG
,NI
,NL
,NO
,NP
,NR
,NT
,NU
,NZ
,OM
,PA
,PE
,PF
,PG
,PH
,PK
,PL
,PM
,PN
,PR
,PS
,PT
,PW
,PY
,QA
,RE
,RO
,RS
,RU
,RW
,SA
,SB
,SC
,SD
,SE
,SF
,SG
,SH
,SI
,SJ
,SK
,SL
,SM
,SN
,SO
,SR
,SS
,ST
,SU
,SV
,SX
,SY
,SZ
,TA
,TC
,TD
,TF
,TG
,TH
,TJ
,TK
,TL
,TM
,TN
,TO
,TP
,TR
,TT
,TV
,TW
,TZ
,UA
,UG
,UK
,UM
,US
,UY
,UZ
,VA
,VC
,VE
,VG
,VI
,VN
,VU
,WF
,WS
,XI
,XU
,XK
,YE
,YT
,YU
,ZA
,ZM
,ZR
,ZW
]The 2-digit country code of the physical postal address according to ISO 3166-1.
administrativeAreaLevel1 stringThe 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.
postalCode stringThe alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.
city stringThe name of the city of the physical postal address, synonyms: town, village, municipality.
deliveryServiceType stringPossible values: [
PO_BOX
,PRIVATE_BAG
,BOITE_POSTALE
]One of the alternative postal address types: P.O. box, private bag, boite postale.
deliveryServiceQualifier stringThe qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities.
deliveryServiceNumber stringThe number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number.
confidenceCriteria object
sharedByOwner booleancheckedByExternalDataSource booleannumberOfBusinessPartners int32lastConfidenceCheckAt date-timenextConfidenceCheckAt date-timeconfidenceLevel int32ownerBpnL stringThe BPNL of the company sharing and claiming this business partner as its own
processingState object
Contains detailed information about the current processing state of a golden record task
resultState stringPossible values: [
Pending
,Success
,Error
]The processing result of the task, can also still be pending
step stringPossible values: [
CleanAndSync
,PoolSync
,Clean
]The last step this task has entered
stepState stringPossible values: [
Queued
,Reserved
,Success
,Error
]Whether the task is queued or already reserved for the latest step
errors object[]
The actual errors that happened during processing if the task has an error result state. The errors refer to the latest step.
type stringPossible values: [
Timeout
,Unspecified
]The type of error that occurred
description stringThe free text, detailed description of the error
createdAt date-timeWhen the task has been created
modifiedAt date-timeWhen the task has last been modified
timeout date-time deprecatedThe timestamp until the task is removed from the Orchestrator
{
"tasks": [
{
"taskId": "string",
"businessPartnerResult": {
"nameParts": [
"string"
],
"identifiers": [
{
"type": "string",
"value": "string",
"issuingBody": "string"
}
],
"states": [
{
"validFrom": "2024-02-22",
"validTo": "2024-02-22",
"type": "ACTIVE"
}
],
"roles": [
"SUPPLIER"
],
"legalEntity": {
"legalEntityBpn": "string",
"legalName": "string",
"shortName": "string",
"legalForm": "string",
"classifications": [
{
"type": "NACE",
"code": "string",
"value": "string"
}
],
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfBusinessPartners": 0,
"lastConfidenceCheckAt": "2024-02-22",
"nextConfidenceCheckAt": "2024-02-22",
"confidenceLevel": 0
}
},
"site": {
"siteBpn": "string",
"name": "string",
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfBusinessPartners": 0,
"lastConfidenceCheckAt": "2024-02-22",
"nextConfidenceCheckAt": "2024-02-22",
"confidenceLevel": 0
}
},
"address": {
"addressBpn": "string",
"name": "string",
"addressType": "LegalAndSiteMainAddress",
"physicalPostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"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"
},
"alternativePostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": "UNDEFINED",
"administrativeAreaLevel1": "string",
"postalCode": "string",
"city": "string",
"deliveryServiceType": "PO_BOX",
"deliveryServiceQualifier": "string",
"deliveryServiceNumber": "string"
},
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfBusinessPartners": 0,
"lastConfidenceCheckAt": "2024-02-22",
"nextConfidenceCheckAt": "2024-02-22",
"confidenceLevel": 0
}
},
"ownerBpnL": "string"
},
"processingState": {
"resultState": "Pending",
"step": "CleanAndSync",
"stepState": "Queued",
"errors": [
{
"type": "Timeout",
"description": "string"
}
],
"createdAt": "2024-02-22",
"modifiedAt": "2024-02-22"
}
}
]
}
On malformed task search requests