Items - 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 Items operation retrieves the data records associated with a collection ID. The response is always returned as GeoJSON.

Several parameters are supported that can be used to constrain or filter the response. You can limit the number of records, specify the number of records returned, filter the records using the CQL2 filter language, or specify a bounding box to restrict the response to only records within the box. The parameters can be used individually or in combination as needed.

Request format

https://api.cloud.precisely.com/v1/ogcapi/enrich/collections/{collectionId}/items?<parameters-as-specified-below>

Request header and query parameters

Name Type Required Description
collectionId * string Yes Unique identifier of the collection.

Format:

/collections/{collectionId}/items

If no parameters other than collectionId are specified, the API returns the first 10 records by default.

Example: 

/collections/buildings/items
limit Integer No Returns the first number of records specified. The example below returns the first 50 records. The maximum limit allowed is 10000

Example:

/collections/{collectionId}/items?limit=50

See also offset below.
offset Integer No Returns the number of specified records starting at the specified offset. In the below example we return the 50 records starting at offset 100 (i.e. records 100 to 149). The response includes links to the next and previous pages when using offset

Example: Returns the 50 records starting at record 100. 

/collections/{collectionId}/items?limit=50&offset=100

See also limit above.
bbox string No Returns the records within the specified bounding box. The co-ordinates for the bbox are in the order (minX, minY, maxX, maxY), where X is the longitude value and Y is the latitude value.

The default limit and offset rules apply. Hence it is usually necessary to specify the limit if more than 10 records are expected.

Example:

/collections/{collectionId}/items?bbox=-3.545148,50.727083,-3.538470,50.728095

See also Items with bbox.
filter string No This parameter accepts a filter clause in the CQL2 filter language standard. Both spatial and attribute filters are supported by CQL2 . The standard is defined here https://www.ogc.org/publications/standard/cql2/. Both spatial and attribute filters are supported by CQL2

The supported spatial filters are listed using the Functions endpoint. They are:

  • s_contains: Returns features from the collection that entirely contain the input geometry.
  • s_within: Returns features from the collection that are entirely within the input geometry.
  • s_intersects: Returns features from the collection that intersect (partially or entirely overlap) the input geometry.
  • bldgid: Returns records relating to the specified building ID.

Example:

/collections/{collectionId}/items?filter=bldgid%3D%27B000CTOWD2PJ%27

Below are some examples of typical filter queries. For a full reference to all of the operations supported by CQL please refer to the standard at the above link.