The getById query is used to search and return data based on a unique
identifier (ID) found in Precisely and Precisely Data Link partner datasets. The query
requires the queryType parameter to specify the type of ID and then the
ID itself. These unique IDs may be obtained from Precisely datasets or from an API response to
previous queries.
IDs available for datasets:
- PreciselyID: query any dataset.
- Building ID: query any dataset related to Precisely Buildings.
- DUNS ID: query Data Link for Duns and Bradstreet and returns Precisely ID and any related datasets.
- GERS ID: query Data Link for Overture and returns Precisely ID and any related datasets.
- Parcel ID: query any dataset related to Precisely Parcels.
- Place ID: query any dataset related to Precisely Places.
Query syntax:
getById(
id: String!
queryType: QueryType!
country: String = "USA"
): RelationEntity| Parameter | Type | Required | Description |
|---|---|---|---|
| id | String | Required | The ID to search on. |
| queryType | QueryType | Required | The type of ID you provided:
|
| country | String | Required if not United States | The country in which the address you are searching for is located. This field is
not case-sensitive.
|
Example
The below query provides the Precisely ID as input and returns the full address record from Address Fabric.
query addressByPreciselyID {
getById(id: "P00002T4PDYV", queryType: PRECISELY_ID) {
addresses {
data {
preciselyID
addressNumber
streetName
unitType
unit
city
admin1ShortName
postalCode
postalCodeExtension
locationCode {
value
description
}
geographyID
latitude
longitude
parentPreciselyID
}
}
}
}