Request - Precisely Data Integrity Suite

Data Integrity Suite APIs
Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

The Bulk Data Graph API's request submits a query to the Data Graph API for each entry specified in the input file.

Request body

Ancestors Parameter Type Required Description
  operation String Required The Data Graph API method to use on the batch of queries. Possible values:
  • DATA_GRAPH_GET_BY_ADDRESS: Use the Data Graph API's getByAddress query to retrieve data based on the input address. For more information, see getByAddress.
  • DATA_GRAPH_GET_BY_ID: Use the Data Graph API's getById query to search and return data based on a unique identifier (ID) found in Precisely and Precisely Data Link partner datasets. For more information, see getById.
  payload JSON Required Contains JSON parameters according to the operation specified. Refer to the tables below.

getByAddress

Input file format

InputId,Address,Country
inputId1,address1,country1
inputId2,address2,country2
inputId3,address3,country3
....

where:

  • The header row is case sensitive and required. InputId and Id are required. Country is optional and does not affect whether or not country values are processed. The header row's possible values are:
    • InputId,Id
    • or InputId,Id,Country
  • inputId: A unique string of alphanumeric characters.
  • address: The address to search on.
  • country: (Optional) The country the address is in.
  • Comma is used as the delimiter between address and country values.
Table 1. getByAddress payload
Ancestors Parameter Type Required Description
payload fileId String Required The ID of the file that contains the parameters necessary for the indicated query type. The ID is generated when the file was uploaded with the Generate Upload URL endpoint.
payload delimiter String Optional The delimiter used in the input file to separate values. The only allowed value is a comma.
payload datasets Array of strings Required An array of datasets and the names of the fields requested to be returned from the datasets, in the format: 
"dataset-name": ["field-name", ..., "field-name"]
For example: 
{"addresses": ["preciselyID", "locationCode","addressNumber"],
 "buildings": ["buildingID", "buildingType"]}

getById

Input file format

InputId,Id,Country
inputId1,id1,country1,
inputId2,id2,country2
....

where:

  • The header row is case sensitive and required. InputId and Id are required. Country is optional and does not affect whether or not country values are processed. The header row's possible values are:
    • InputId,Id
    • or InputId,Id,Country
  • inputId: A unique string of alphanumeric characters.
  • id: The id to search on.
  • country: (Optional) The country the address you are searching is in.
  • Comma is used as a delimiter between id and country.
Table 2. getById payload
Ancestors Parameter Type Required Description
payload fileId String Required The ID of the file that contains the parameters necessary for the indicated query type. The ID is generated when the file was uploaded with the Generate Upload URL endpoint.
payload delimiter String Optional The delimiter used in the input file to separate values. The only delimiter allowed is comma.
payload queryType QueryType Required The type of ID you provided:
  • BUILDING_ID: Unique building identifier
  • DUNS_ID: Unique ID for Dun & Bradstreet
  • GERS_ID: Unique ID for Overture
  • PARCEL_ID: Unique feature ID for a parcel boundary record
  • PLACE_ID: Unique place identifier
  • PRECISELY_ID: Unique ID for an addressable location
payload datasets Array of strings Required An array of datasets and the names of the fields requested to be returned from the datasets, in the format: 
"dataset-name": ["field-name", ..., "field-name"]
 For example: 
{"addresses": ["preciselyID", "locationCode","addressNumber"],
 "buildings": ["buildingID", "buildingType"]}

Examples

{
   "operation": "DATA_GRAPH_GET_BY_ADDRESS",
   "payload":{
      "fileId": "ebb7aa05-ce62-4b98-b45d-0b9edff4cadf",
      "delimiter": ",",
      "datasets": {
         "addresses": ["longitude", "latitude", "buildingType", "geometry"]
         "parcels": ["parcelID", "fips", "parcelArea"],
         "buildings": ["buildingID","longitude", "latitude"],
         "WildFireRisk": ["preciselyID"]
      }
   }
}
 
{
    "operation": "DATA_GRAPH_GET_BY_ID",
    "payload":{
        "fileId": "ebb7aa05-ce62-4b98-b45d-0b9edff4cadf",
        "delimiter": ",",
        "queryType": "PRECISELY_ID",
        "datasets": {
            "parcels": ["parcelID", "fips", "parcelArea"],
            "buildings": ["buildingID","longitude", "latitude"],
            "addresses": ["preciselyID", "addressNumber"],
            "WildFireRisk": ["preciselyID"]
        }
    }
}