Skip to main content
Version: 24.03

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.

Request Body required
  • taskIds string[] required
Responses

The state of the tasks for the provided task identifiers.


Schema
  • tasks object[]
  • taskId string
  • businessPartnerResult 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 string

    Technical key of the type to which this identifier belongs to

  • value string

    Value of the identifier

  • issuingBody string

    Body which issued the identifier

  • states object[]

    The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.

  • validFrom date-time

    Date since when the status is/was valid.

  • validTo date-time

    Date until the status was valid, if applicable.

  • type string

    Possible 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 string

    The BPNL of the legal entity, on which the business partner provides a view.

  • legalName string

    The name of the legal entity, on which the business partner provides a view, according to official registers.

  • shortName string

    The abbreviated name of the legal entity, on which the business partner provides a view.

  • legalForm string

    The 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 string

    Possible values: [NACE, NAF, NAICS, SIC]

    Type of classification.

  • code string

    The identifier of the class belonging to the classification.

  • value string

    The name of the class belonging to the classification.

  • confidenceCriteria object
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfBusinessPartners int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • site object

    The site, on which the business partner provides a view.

  • siteBpn string

    The BPNS of the site, on which the business partner provides a view.

  • name string

    The 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 boolean
  • checkedByExternalDataSource boolean
  • numberOfBusinessPartners int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • address object

    The address, on which the business partner provides a view.

  • addressBpn string

    The BPNA of the address, on which the business partner provides a view.

  • name string

    The 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 string

    Possible 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 float

    Longitude coordinate

  • latitude float

    Latitude coordinate

  • altitude float

    Altitude, if applicable

  • country string

    Possible 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 string

    The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.

  • administrativeAreaLevel2 string

    The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country.

  • administrativeAreaLevel3 string

    The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country.

  • postalCode string

    The 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 string

    The name of the city of the physical postal address, synonyms: town, village, municipality.

  • district string

    The name of the district of the physical postal address which divides the city in several smaller areas.

  • street object
  • name string

    The name of the street.

  • houseNumber string

    The number representing the exact location of a building within the street.

  • houseNumberSupplement string
  • milestone string

    The number representing the exact location of an addressed object within a street without house numbers, such as within long roads.

  • direction string

    The 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 string

    The street related information, which is usually printed before the official street name on an address label.

  • additionalNamePrefix string

    The additional street related information, which is usually printed before the official street name on an address label.

  • nameSuffix string

    The street related information, which is usually printed after the official street name on an address label.

  • additionalNameSuffix string

    The additional street related information, which is usually printed after the official street name on an address label.

  • companyPostalCode string

    The company postal code of the physical postal address, which is sometimes required for large companies.

  • industrialZone string

    The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area.

  • building string

    The alphanumeric identifier of the building addressed by the physical postal address.

  • floor string

    The number of a floor in the building addressed by the physical postal address, synonym: level.

  • door string

    The 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 float

    Longitude coordinate

  • latitude float

    Latitude coordinate

  • altitude float

    Altitude, if applicable

  • country string

    Possible 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 string

    The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.

  • postalCode string

    The 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 string

    The name of the city of the physical postal address, synonyms: town, village, municipality.

  • deliveryServiceType string

    Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]

    One of the alternative postal address types: P.O. box, private bag, boite postale.

  • deliveryServiceQualifier string

    The 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 string

    The 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 boolean
  • checkedByExternalDataSource boolean
  • numberOfBusinessPartners int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • ownerBpnL string

    The 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 string

    Possible values: [Pending, Success, Error]

    The processing result of the task, can also still be pending

  • step string

    Possible values: [CleanAndSync, PoolSync, Clean]

    The last step this task has entered

  • stepState string

    Possible 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 string

    Possible values: [Timeout, Unspecified]

    The type of error that occurred

  • description string

    The free text, detailed description of the error

  • createdAt date-time

    When the task has been created

  • modifiedAt date-time

    When the task has last been modified

  • timeout date-time deprecated

    The timestamp until the task is removed from the Orchestrator

Loading...