Accelerate the Value of Data

Get Batch Mapping

The Get Batch Mapping operation.

Request

GET: {dnbConnectorUrl}/config/profiles/{profile}/mappings/batch
Table 1. Parameters
Parameter Name Required Description
Headers Content-Type Yes Should be Content-Type:application/json.
Headers Authorization Yes Information about authentication access token in format Bearer <accessToken>.
Path profile Yes Profile Name.
Query plus No Use plus mapping. Default value: true

Response

HTTP CODE:
Success: 200
[
  {
    "operation": "shift",
    "spec": {
      "embeddedProduct": {
        "organization": "organization"
      },
      "matchCandidates": {
        "0": {
          "matchQualityInformation": {
            "confidenceCode": "confidenceCode"
          }
        }
      }
    }
  },
  {
    "operation": "shift",
    "spec": {
      "confidenceCode": "[4].attributes.MatchQuality[0].value.ConfidenceCode[].value",
      "organization": {
        "#configuration/sources/DnB": "[4].crosswalks[0].type",
        "#Batch Plus": "[4].attributes.DnBSource[].value",
        "duns": ["[4].attributes.DUNSNumber[].value", "[4].crosswalks[0].value"],
        "dunsControlStatus": {
          "isMarketable": "[4].attributes.MarketabilityIndicator[].value",
          "lastUpdateDate": "[4].attributes.DnBLastUpdateDate[].value",
          "operatingStatus": {
            "description": ["[4].attributes.OrganizationDetail[0].value.OperatingStatusComment[].value",
              "[4].attributes.OrganizationDetail[0].value.OperatingStatus[].value"]
          }
        },
        "primaryName": "[4].attributes.Name[].value",
        "tradeStyleNames": {
          "*": {
            "name": "[4].attributes.TradeStyleName[&1].value.OrganizationName[].value"
          }
        },
        "telephone": {
          "*": {
            "telephoneNumber": "[5].sa.Phone[&1].value.Number[].value",
            "isUnreachable": "[5].sa.Phone[&1].value.Unreachable[].value",
            "isdCode": "[5].sa.Phone[&1].value.CountryCode[].value",
            "#Phone": "[5].sa.Phone[&1].value.Type[].value",
            "#true": "[5].sa.Phone[&1].value.PrimaryPhoneFlag[].value"
          }
        },
        "fax": {
          "*": {
            "faxNumber": "[5].ma.Phone[&1].value.Number[].value",
            "isUnreachable": "[5].ma.Phone[&1].value.Unreachable[].value",
            "isdCode": "[5].ma.Phone[&1].value.CountryCode[].value",
            "#Fax": "[5].ma.Phone[&1].value.Type[].value",
            "#true": "[5].ma.Phone[&1].value.PrimaryPhoneFlag[].value"
          }
        },
        "websiteAddress": {
          "*": {
            "url": "[4].attributes.WebsiteURL[].value"
          }
        },
        "isStandalone": "[4].attributes.OrganizationDetail[0].value.Standalone[].value",
        "controlOwnershipDate": "[4].attributes.OrganizationDetail[0].value.OwnershipDate[].value",
        "controlOwnershipType": {
          "description": "[4].attributes.OrganizationDetail[0].value.OwnershipType[].value"
        },
        "startDate": "[4].attributes.OrganizationDetail[0].value.StartYear[].value",
        "primaryAddress": {
          "streetAddress": {
            "line1": "[5].sa.Addresses[0].value.AddressLine1[].value",
            "line2": "[5].sa.Addresses[0].value.AddressLine2[].value",
            "#Shipping": "[5].sa.Addresses[0].value.AddressType[].value",
            "#true": "[5].sa.Addresses[0].value.Primary[].value",
            "@(1,postalCode)": "[5].sa.Addresses[0].value.PostalCode[].value",
            "@(1,addressLocality)": {
              "name": "[5].sa.Addresses[0].value.City[].value"
            },
            //"@(1,TerritoryOfficialName)": "[5].sa.Addresses[&2].value.StateProvince[].value",
            "@(1,addressRegion)": {
              "name": "[5].sa.Addresses[0].value.StateProvince[].value"
            },
            "@(1,latitude)": "[5].sa.Addresses[0].value.DnBLatitude[].value",
            "@(1,longitude)": "[5].sa.Addresses[0].value.DnBLongitude[].value",
            "@(1,isRegisteredAddress)": "[5].sa.Addresses[0].value.Registered[].value",
            "@(1,isResidentialAddress)": "[5].sa.Addresses[0].value.Residential[].value",
            //"@(1,CountryISOAlpha2Code)": "[5].sa.Addresses[&2].value.Country[].value",
            "@(1,addressCountry)": {
              "name": "[5].sa.Addresses[0].value.Country[].value"
            }
          }
        },
        "mailingAddress": {
          "streetAddress": {
            "line1": "[5].ma.Addresses[0].value.AddressLine1[].value",
            "line2": "[5].ma.Addresses[0].value.AddressLine2[].value",
            "#Mailing": "[5].ma.Addresses[0].value.AddressType[].value",
            "@(1,postalCode)": "[5].ma.Addresses[0].value.PostalCode[].value",
            "@(1,addressLocality)": {
              "name": "[5].ma.Addresses[0].value.City[].value"
            },
            "@(1,addressRegion)": {
              "name": "[5].ma.Addresses[0].value.StateProvince[].value"
            },
            "@(1,latitude)": "[5].ma.Addresses[0].value.DnBLatitude[].value",
            "@(1,longitude)": "[5].ma.Addresses[0].value.DnBLongitude[].value",
            "@(1,isRegisteredAddress)": "[5].ma.Addresses[0].value.Registered[].value",
            "@(1,isResidentialAddress)": "[5].ma.Addresses[0].value.Residential[].value",
            "@(1,addressCountry)": {
              "name": "[5].ma.Addresses[0].value.Country[].value"
            }
          }
        },
        "financials": {
          "*": {
            "financialStatementToDate": "[4].attributes.KeyFinancialFiguresOverview[&1].value.FinancialStatementToDate[].value",
            "financialStatementDuration": "[4].attributes.KeyFinancialFiguresOverview[&1].value.FinancialPeriodDuration[].value",
            "yearlyRevenue": {
              "*": {
                "value": "[4].attributes.KeyFinancialFiguresOverview[&3].value.SalesRevenueAmount[&1].value",
                "currency": "[4].attributes.KeyFinancialFiguresOverview[&3].value.SalesRevenueCurrencyCode[&1].value"
              }
            }
          }
        },
        "industryCodes": {
          "*": {
            "code": "[4].attributes.IndustryCode[&1].value.IndustryCode[].value",
            "description": "[4].attributes.IndustryCode[&1].value.IndustryCodeDescription[].value",
            "typeDescription": "[4].attributes.IndustryCode[&1].value.Type[].value",
            "typeDnBCode": "[4].attributes.IndustryCode[&1].value.DNBCode[].value"
          }
        },
        "isImporter": "[4].attributes.ActivitiesAndOperations[0].value.ImportIndicator[].value",
        "isExporter": "[4].attributes.ActivitiesAndOperations[0].value.ExportIndicator[].value",
        "isAgent": "[4].attributes.ActivitiesAndOperations[0].value.AgentIndicator[].value",
        "numberOfEmployees": {
          "*": {
            "value": "[4].attributes.EmployeeDetails[&1].value.IndividualTotalEmployeeQuantity[].value",
            "reliabilityDescription": "[4].attributes.EmployeeDetails[&1].value.IndividualReliabilityText[].value"
          }
        },
        "businessEntityType": {
          "description": "[4].attributes.LegalStatusCode[].value"
        },
        "registrationNumbers": {
          "*": {
            "registrationNumber": "[4].attributes.Identifiers[&1].value.ID[].value",
            "typeDescription": "[4].attributes.Identifiers[&1].value.Type[].value"
          }
        },
        "corporateLinkage": {
          "familytreeRolesPlayed": {
            "*": {
              "description": "[4].attributes.OrganizationDetail[0].value.MemberRole[].value"
            }
          },
          "globalUltimate": {
            "duns": {
              "@": [
                "[0].attributes.DUNSNumber[].value",
                "[4].attributes.DUNSHierarchy[0].value.GlobalUltimateDUNS[].value",
                "[0].crosswalks[0].value"
              ],
              "#configuration/entityTypes/Organization": "[0].type",
              "#configuration/sources/DnB": "[0].crosswalks[0].type",
              "#DnB Linkage": "[0].attributes.VendorOrganizationType[].value",
              "#Batch Plus": "[0].attributes.DnBSource[].value",
              "@(1,primaryName)": ["[0].attributes.Name[0].value", "[4].attributes.DUNSHierarchy[0].value.GlobalUltimateOrganization[].value"],
              "@(1,primaryAddress)": {
                "streetAddress": {
                  "line1": "[0].attributes.Addresses[0].value.AddressLine1[].value",
                  "line2": "[0].attributes.Addresses[0].value.AddressLine2[].value",
                  "#Shipping": "[0].attributes.Addresses[0].value.AddressType[].value",
                  "#true": "[0].attributes.Addresses[0].value.Primary[].value",
                  "@(1,postalCode)": "[0].attributes.Addresses[0].value.PostalCode[].value",
                  "@(1,addressLocality)": {
                    "name": "[0].attributes.Addresses[0].value.City[].value"
                  },
                  "@(1,addressRegion)": {
                    "name": "[0].attributes.Addresses[0].value.StateProvince[].value"
                  },
                  "@(1,addressCountry)": {
                    "name": "[0].attributes.Addresses[0].value.Country[].value"
                  }
                }
              }
            }
          },
          "domesticUltimate": {
            "duns": {
              "@": [
                "[1].attributes.DUNSNumber[].value",
                "[4].attributes.DUNSHierarchy[0].value.DomesticUltimateDUNS[].value",
                "[1].crosswalks[0].value"
              ],
              "#configuration/entityTypes/Organization": "[1].type",
              "#configuration/sources/DnB": "[1].crosswalks[0].type",
              "#DnB Linkage": "[1].attributes.VendorOrganizationType[].value",
              "#Batch Plus": "[1].attributes.DnBSource[].value",
              "@(1,primaryName)": ["[1].attributes.Name[0].value", "[4].attributes.DUNSHierarchy[0].value.DomesticUltimateOrganization[].value"],
              "@(1,primaryAddress)": {
                "streetAddress": {
                  "line1": "[1].attributes.Addresses[0].value.AddressLine1[].value",
                  "line2": "[1].attributes.Addresses[0].value.AddressLine2[].value",
                  "#Shipping": "[1].attributes.Addresses[0].value.AddressType[].value",
                  "#true": "[1].attributes.Addresses[0].value.Primary[].value",
                  "@(1,postalCode)": "[1].attributes.Addresses[0].value.PostalCode[].value",
                  "@(1,addressLocality)": {
                    "name": "[1].attributes.Addresses[0].value.City[].value"
                  },
                  "@(1,addressRegion)": {
                    "name": "[1].attributes.Addresses[0].value.StateProvince[].value"
                  },
                  "@(1,addressCountry)": {
                    "name": "[1].attributes.Addresses[0].value.Country[].value"
                  }
                }
              }
            }
          },
          "headQuarter": {
            "duns": {
              "@": [
                "[2].attributes.DUNSNumber[].value",
                "[4].attributes.DUNSHierarchy[0].value.HeadquartersDUNS[].value",
                "[2].crosswalks[0].value"
              ],
              "#configuration/entityTypes/Organization": "[2].type",
              "#configuration/sources/DnB": "[2].crosswalks[0].type",
              "#DnB Linkage": "[2].attributes.VendorOrganizationType[].value",
              "#Batch Plus": "[2].attributes.DnBSource[].value",
              "@(1,primaryName)": ["[2].attributes.Name[0].value", "[4].attributes.DUNSHierarchy[0].value.HeadquartersOrganization[].value"],
              "@(1,primaryAddress)": {
                "streetAddress": {
                  "line1": "[2].attributes.Addresses[0].value.AddressLine1[].value",
                  "line2": "[2].attributes.Addresses[0].value.AddressLine2[].value",
                  "#Shipping": "[2].attributes.Addresses[0].value.AddressType[].value",
                  "#true": "[2].attributes.Addresses[0].value.Primary[].value",
                  "@(1,postalCode)": "[2].attributes.Addresses[0].value.PostalCode[].value",
                  "@(1,addressLocality)": {
                    "name": "[2].attributes.Addresses[0].value.City[].value"
                  },
                  "@(1,addressRegion)": {
                    "name": "[2].attributes.Addresses[0].value.StateProvince[].value"
                  },
                  "@(1,addressCountry)": {
                    "name": "[2].attributes.Addresses[0].value.Country[].value"
                  }
                }
              }
            }
          },
          "parent": {
            "duns": {
              "@": [
                "[3].attributes.DUNSNumber[].value",
                "[4].attributes.DUNSHierarchy[0].value.ParentDUNS[].value",
                "[3].crosswalks[0].value"
              ],
              "#configuration/entityTypes/Organization": "[3].type",
              "#configuration/sources/DnB": "[3].crosswalks[0].type",
              "#DnB Linkage": "[3].attributes.VendorOrganizationType[].value",
              "#Batch Plus": "[3].attributes.DnBSource[].value",
              "@(1,primaryName)": ["[3].attributes.Name[0].value", "[4].attributes.DUNSHierarchy[0].value.ParentOrganization[].value"],
              "@(1,primaryAddress)": {
                "streetAddress": {
                  "line1": "[3].attributes.Addresses[0].value.AddressLine1[].value",
                  "line2": "[3].attributes.Addresses[0].value.AddressLine2[].value",
                  "#Shipping": "[3].attributes.Addresses[0].value.AddressType[].value",
                  "#true": "[3].attributes.Addresses[0].value.Primary[].value",
                  "@(1,postalCode)": "[3].attributes.Addresses[0].value.PostalCode[].value",
                  "@(1,addressLocality)": {
                    "name": "[3].attributes.Addresses[0].value.City[].value"
                  },
                  "@(1,addressRegion)": {
                    "name": "[3].attributes.Addresses[0].value.StateProvince[].value"
                  },
                  "@(1,addressCountry)": {
                    "name": "[3].attributes.Addresses[0].value.Country[].value"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  {
    "operation": "shift",
    "spec": {
      "0": {
        "type": "[0].type",
        "crosswalks": "[0].crosswalks",
        "attributes": "[0].attributes"
      },
      "1": {
        "type": "[1].type",
        "crosswalks": "[1].crosswalks",
        "attributes": "[1].attributes"
      },
      "2": {
        "type": "[2].type",
        "crosswalks": "[2].crosswalks",
        "attributes": "[2].attributes"
      },
      "3": {
        "type": "[3].type",
        "crosswalks": "[3].crosswalks",
        "attributes": "[3].attributes"
      },
      "4": {
        "type": "[4].type",
        "crosswalks": "[4].crosswalks",
        "attributes": "[4].attributes"
      },
      "5": {
        "ma": {
          "Addresses": {
            "*": "[4].attributes.Addresses[]"
          },
          "Phone": {
            "*": "[4].attributes.Phone[]"
          }
        },
        "sa": {
          "Addresses": {
            "*": "[4].attributes.Addresses[]"
          },
          "Phone": {
            "*": "[4].attributes.Phone[]"
          }
        }
      }
    }
  },
  {
    "operation": "com.reltio.account360.connector.dnb.mappings.SetFinancialStatementToDate"
  },
  // section below doesn't make useful actions - only replaces null to { "attributes": {}} - empty organization
  // why? - we need it in case when only one organization here and other are null - in this case last modifier will
  // create array[] instead of array[array[]] and crash conversion to List<List<>>
  {
    "operation": "modify-overwrite-beta",
    "spec": {
      "*": {
        "attributes": {
          "SomeValue": {
            "*": {
              "value": "&"
            }
          }
        }
      }
    }
  },
  {
    "operation": "shift",
    "spec": {
      "*": "[0]"
    }
  }
]

Errors

400 Bad Request
500 Internal Server Error