Search documentation
karat

+

K

User Documentation ↗

Aggregate Objects

POST/api/v2/ontologies/{ontology}/objects/{objectType}/aggregate

Perform functions on object fields in the specified ontology and object type.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontologies-read.

Path parameters

ontology
string

The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.

objectType
string

The type of the object to aggregate on.

Query parameters

artifactRepository
string
optional

The repository associated with a marketplace installation.

packageName
string
optional

The package name of the generated SDK.

Request body

AggregateObjectsRequestV2
object
Hide children

Hide children

aggregation
list<AggregationV2>
optional
Show children

Show children

AggregationV2
union

Specifies an aggregation function.

Show children

Show children

approximateDistinct
object
optional

Computes an approximate number of distinct values for the provided field.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

name
string
optional

A user-specified alias for an aggregation metric name.

direction
string (enum)
optional

Enum values: ASC, DESC

min
object
optional

Computes the minimum value for the provided field.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

name
string
optional

A user-specified alias for an aggregation metric name.

direction
string (enum)
optional

Enum values: ASC, DESC

avg
object
optional

Computes the average value for the provided field.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

name
string
optional

A user-specified alias for an aggregation metric name.

direction
string (enum)
optional

Enum values: ASC, DESC

max
object
optional

Computes the maximum value for the provided field.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

name
string
optional

A user-specified alias for an aggregation metric name.

direction
string (enum)
optional

Enum values: ASC, DESC

approximatePercentile
object
optional

Computes the approximate percentile value for the provided field. Requires Object Storage V2.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

name
string
optional

A user-specified alias for an aggregation metric name.

approximatePercentile
number
direction
string (enum)
optional

Enum values: ASC, DESC

count
object
optional

Computes the total count of objects.

Show children

Show children

name
string
optional

A user-specified alias for an aggregation metric name.

direction
string (enum)
optional

Enum values: ASC, DESC

sum
object
optional

Computes the sum of values for the provided field.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

name
string
optional

A user-specified alias for an aggregation metric name.

direction
string (enum)
optional

Enum values: ASC, DESC

exactDistinct
object
optional

Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

name
string
optional

A user-specified alias for an aggregation metric name.

direction
string (enum)
optional

Enum values: ASC, DESC

where
union
optional
Show children

Show children

or
object
optional

Returns objects where at least 1 query is satisfied.

Show children

Show children

value
list<SearchJsonQueryV2>
optional
Show children

Show children

SearchJsonQueryV2
union
Show children

Show children

or
object
optional

Returns objects where at least 1 query is satisfied.

Show children

Show children

value
list<SearchJsonQueryV2>
optional
Show children

Show children

SearchJsonQueryV2
union
in
object
optional

Returns objects where the specified field equals any of the provided values.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
list<PropertyValue>
optional
Show children

Show children

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

doesNotIntersectPolygon
object
optional

Returns objects where the specified field does not intersect the polygon provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show children

Show children

Polygon
object
optional
Show children

Show children

coordinates
list<LinearRing>
optional
Show children

Show children

LinearRing
list<Position>

A linear ring is a closed LineString with four or more positions.

The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.

A linear ring is the boundary of a surface or the boundary of a hole in a surface.

A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.

Show children

Show children

Position
list<Coordinate>

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
lt
object
optional

Returns objects where the specified field is less than a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

doesNotIntersectBoundingBox
object
optional

Returns objects where the specified field does not intersect the bounding box provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show children

Show children

topLeft
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
bottomRight
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
eq
object
optional

Returns objects where the specified field is equal to a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

containsAllTerms
object
optional

Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gt
object
optional

Returns objects where the specified field is greater than a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

withinDistanceOf
object
optional

Returns objects where the specified field contains a point within the distance provided of the center point.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The coordinate point to use as the center of the distance query.

Show children

Show children

center
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
distance
object

A measurement of distance.

Show children

Show children

value
number
unit
string (enum)

Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES

withinBoundingBox
object
optional

Returns objects where the specified field contains a point within the bounding box provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show children

Show children

topLeft
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
bottomRight
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

not
object
optional

Returns objects where the query is not satisfied.

Show children

Show children

value
union
intersectsBoundingBox
object
optional

Returns objects where the specified field intersects the bounding box provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show children

Show children

topLeft
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
bottomRight
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show children

Show children

value
list<SearchJsonQueryV2>
optional
Show children

Show children

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
containsAnyTerm
object
optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gte
object
optional

Returns objects where the specified field is greater than or equal to a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

containsAllTermsInOrder
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
withinPolygon
object
optional

Returns objects where the specified field contains a point within the polygon provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show children

Show children

Polygon
object
optional
Show children

Show children

coordinates
list<LinearRing>
optional
Show children

Show children

LinearRing
list<Position>

A linear ring is a closed LineString with four or more positions.

The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.

A linear ring is the boundary of a surface or the boundary of a hole in a surface.

A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.

Show children

Show children

Position
list<Coordinate>

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show children

Show children

Polygon
object
optional
Show children

Show children

coordinates
list<LinearRing>
optional
Show children

Show children

LinearRing
list<Position>

A linear ring is a closed LineString with four or more positions.

The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.

A linear ring is the boundary of a surface or the boundary of a hole in a surface.

A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.

Show children

Show children

Position
list<Coordinate>

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
lte
object
optional

Returns objects where the specified field is less than or equal to a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

startsWith
object
optional

Returns objects where the specified field starts with the provided value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
in
object
optional

Returns objects where the specified field equals any of the provided values.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
list<PropertyValue>
optional
Show children

Show children

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

doesNotIntersectPolygon
object
optional

Returns objects where the specified field does not intersect the polygon provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show children

Show children

Polygon
object
optional
Show children

Show children

coordinates
list<LinearRing>
optional
Show children

Show children

LinearRing
list<Position>

A linear ring is a closed LineString with four or more positions.

The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.

A linear ring is the boundary of a surface or the boundary of a hole in a surface.

A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.

Show children

Show children

Position
list<Coordinate>

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
lt
object
optional

Returns objects where the specified field is less than a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

doesNotIntersectBoundingBox
object
optional

Returns objects where the specified field does not intersect the bounding box provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show children

Show children

topLeft
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
bottomRight
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
eq
object
optional

Returns objects where the specified field is equal to a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

containsAllTerms
object
optional

Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gt
object
optional

Returns objects where the specified field is greater than a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

withinDistanceOf
object
optional

Returns objects where the specified field contains a point within the distance provided of the center point.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The coordinate point to use as the center of the distance query.

Show children

Show children

center
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
distance
object

A measurement of distance.

Show children

Show children

value
number
unit
string (enum)

Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES

withinBoundingBox
object
optional

Returns objects where the specified field contains a point within the bounding box provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show children

Show children

topLeft
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
bottomRight
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

not
object
optional

Returns objects where the query is not satisfied.

Show children

Show children

value
union
Show children

Show children

or
object
optional

Returns objects where at least 1 query is satisfied.

Show children

Show children

value
list<SearchJsonQueryV2>
optional
Show children

Show children

SearchJsonQueryV2
union
in
object
optional

Returns objects where the specified field equals any of the provided values.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
list<PropertyValue>
optional
Show children

Show children

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

doesNotIntersectPolygon
object
optional

Returns objects where the specified field does not intersect the polygon provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show children

Show children

Polygon
object
optional
Show children

Show children

coordinates
list<LinearRing>
optional
Show children

Show children

LinearRing
list<Position>

A linear ring is a closed LineString with four or more positions.

The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.

A linear ring is the boundary of a surface or the boundary of a hole in a surface.

A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.

Show children

Show children

Position
list<Coordinate>

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
lt
object
optional

Returns objects where the specified field is less than a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

doesNotIntersectBoundingBox
object
optional

Returns objects where the specified field does not intersect the bounding box provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show children

Show children

topLeft
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
bottomRight
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
eq
object
optional

Returns objects where the specified field is equal to a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

containsAllTerms
object
optional

Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gt
object
optional

Returns objects where the specified field is greater than a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

withinDistanceOf
object
optional

Returns objects where the specified field contains a point within the distance provided of the center point.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The coordinate point to use as the center of the distance query.

Show children

Show children

center
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
distance
object

A measurement of distance.

Show children

Show children

value
number
unit
string (enum)

Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES

withinBoundingBox
object
optional

Returns objects where the specified field contains a point within the bounding box provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show children

Show children

topLeft
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
bottomRight
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

not
object
optional

Returns objects where the query is not satisfied.

Show children

Show children

value
union
intersectsBoundingBox
object
optional

Returns objects where the specified field intersects the bounding box provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show children

Show children

topLeft
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
bottomRight
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show children

Show children

value
list<SearchJsonQueryV2>
optional
Show children

Show children

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
containsAnyTerm
object
optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gte
object
optional

Returns objects where the specified field is greater than or equal to a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

containsAllTermsInOrder
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
withinPolygon
object
optional

Returns objects where the specified field contains a point within the polygon provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show children

Show children

Polygon
object
optional
Show children

Show children

coordinates
list<LinearRing>
optional
Show children

Show children

LinearRing
list<Position>

A linear ring is a closed LineString with four or more positions.

The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.

A linear ring is the boundary of a surface or the boundary of a hole in a surface.

A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.

Show children

Show children

Position
list<Coordinate>

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show children

Show children

Polygon
object
optional
Show children

Show children

coordinates
list<LinearRing>
optional
Show children

Show children

LinearRing
list<Position>

A linear ring is a closed LineString with four or more positions.

The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.

A linear ring is the boundary of a surface or the boundary of a hole in a surface.

A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.

Show children

Show children

Position
list<Coordinate>

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
lte
object
optional

Returns objects where the specified field is less than or equal to a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

startsWith
object
optional

Returns objects where the specified field starts with the provided value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
intersectsBoundingBox
object
optional

Returns objects where the specified field intersects the bounding box provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show children

Show children

topLeft
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
bottomRight
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show children

Show children

value
list<SearchJsonQueryV2>
optional
Show children

Show children

SearchJsonQueryV2
union
Show children

Show children

or
object
optional

Returns objects where at least 1 query is satisfied.

Show children

Show children

value
list<SearchJsonQueryV2>
optional
Show children

Show children

SearchJsonQueryV2
union
in
object
optional

Returns objects where the specified field equals any of the provided values.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
list<PropertyValue>
optional
Show children

Show children

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

doesNotIntersectPolygon
object
optional

Returns objects where the specified field does not intersect the polygon provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show children

Show children

Polygon
object
optional
Show children

Show children

coordinates
list<LinearRing>
optional
Show children

Show children

LinearRing
list<Position>

A linear ring is a closed LineString with four or more positions.

The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.

A linear ring is the boundary of a surface or the boundary of a hole in a surface.

A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.

Show children

Show children

Position
list<Coordinate>

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
lt
object
optional

Returns objects where the specified field is less than a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

doesNotIntersectBoundingBox
object
optional

Returns objects where the specified field does not intersect the bounding box provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show children

Show children

topLeft
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
bottomRight
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
eq
object
optional

Returns objects where the specified field is equal to a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

containsAllTerms
object
optional

Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gt
object
optional

Returns objects where the specified field is greater than a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

withinDistanceOf
object
optional

Returns objects where the specified field contains a point within the distance provided of the center point.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The coordinate point to use as the center of the distance query.

Show children

Show children

center
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
distance
object

A measurement of distance.

Show children

Show children

value
number
unit
string (enum)

Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES

withinBoundingBox
object
optional

Returns objects where the specified field contains a point within the bounding box provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show children

Show children

topLeft
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
bottomRight
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

not
object
optional

Returns objects where the query is not satisfied.

Show children

Show children

value
union
intersectsBoundingBox
object
optional

Returns objects where the specified field intersects the bounding box provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show children

Show children

topLeft
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
bottomRight
union
Show children

Show children

Point
object
optional
Show children

Show children

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show children

Show children

value
list<SearchJsonQueryV2>
optional
Show children

Show children

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
containsAnyTerm
object
optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gte
object
optional

Returns objects where the specified field is greater than or equal to a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

containsAllTermsInOrder
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
withinPolygon
object
optional

Returns objects where the specified field contains a point within the polygon provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show children

Show children

Polygon
object
optional
Show children

Show children

coordinates
list<LinearRing>
optional
Show children

Show children

LinearRing
list<Position>

A linear ring is a closed LineString with four or more positions.

The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.

A linear ring is the boundary of a surface or the boundary of a hole in a surface.

A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.

Show children

Show children

Position
list<Coordinate>

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show children

Show children

Polygon
object
optional
Show children

Show children

coordinates
list<LinearRing>
optional
Show children

Show children

LinearRing
list<Position>

A linear ring is a closed LineString with four or more positions.

The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.

A linear ring is the boundary of a surface or the boundary of a hole in a surface.

A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.

Show children

Show children

Position
list<Coordinate>

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
lte
object
optional

Returns objects where the specified field is less than or equal to a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

startsWith
object
optional

Returns objects where the specified field starts with the provided value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
isNull
object
optional

Returns objects based on the existence of the specified field.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
containsAnyTerm
object
optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gte
object
optional

Returns objects where the specified field is greater than or equal to a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

containsAllTermsInOrder
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
withinPolygon
object
optional

Returns objects where the specified field contains a point within the polygon provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show children

Show children

Polygon
object
optional
Show children

Show children

coordinates
list<LinearRing>
optional
Show children

Show children

LinearRing
list<Position>

A linear ring is a closed LineString with four or more positions.

The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.

A linear ring is the boundary of a surface or the boundary of a hole in a surface.

A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.

Show children

Show children

Position
list<Coordinate>

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show children

Show children

Polygon
object
optional
Show children

Show children

coordinates
list<LinearRing>
optional
Show children

Show children

LinearRing
list<Position>

A linear ring is a closed LineString with four or more positions.

The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.

A linear ring is the boundary of a surface or the boundary of a hole in a surface.

A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.

Show children

Show children

Position
list<Coordinate>

GeoJSon fundamental geometry construct.

A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.

Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show children

Show children

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Show children

Show children

Coordinate
number
lte
object
optional

Returns objects where the specified field is less than or equal to a value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

startsWith
object
optional

Returns objects where the specified field starts with the provided value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
groupBy
list<AggregationGroupByV2>
optional
Show children

Show children

AggregationGroupByV2
union

Specifies a grouping for aggregation results.

Show children

Show children

duration
object
optional

Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. When grouping by YEARS, QUARTERS, MONTHS, or WEEKS, the value must be set to 1.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
integer
unit
string (enum)

Enum values: MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS, QUARTERS

fixedWidth
object
optional

Divides objects into groups with the specified width.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

fixedWidth
integer
ranges
object
optional

Divides objects into groups according to specified ranges.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

ranges
list<AggregationRangeV2>
optional
Show children

Show children

AggregationRangeV2
object

Specifies a range from an inclusive start value to an exclusive end value.

Show children

Show children

startValue
any

Inclusive start.

endValue
any

Exclusive end.

exact
object
optional

Divides objects into groups according to an exact value.

Show children

Show children

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

maxGroupCount
integer
optional
accuracy
string (enum)
optional

Enum values: REQUIRE_ACCURATE, ALLOW_APPROXIMATE

Response body

AggregateObjectsResponseV2
object

Success response.

Hide children

Hide children

excludedItems
integer
optional
accuracy
string (enum)

Enum values: ACCURATE, APPROXIMATE

data
list<AggregateObjectsResponseItemV2>
optional
Show children

Show children

AggregateObjectsResponseItemV2
object
Show children

Show children

group
map<AggregationGroupKeyV2, AggregationGroupValueV2>
optional
Show children

Show children

AggregationGroupKeyV2
string
AggregationGroupValueV2
any
metrics
list<AggregationMetricResultV2>
optional
Show children

Show children

AggregationMetricResultV2
object
Show children

Show children

name
string
value
any
optional

The value of the metric. This will be a double in the case of a numeric metric, or a date string in the case of a date metric.

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ -H "Content-type: application/json" \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/ontologies/palantir/objects/employee/aggregate?artifactRepository=&packageName=" \ -d '{"aggregation":[{"type":"min","field":"properties.tenure","name":"min_tenure"},{"type":"avg","field":"properties.tenure","name":"avg_tenure"}],"query":{"not":{"field":"name","eq":"john"}},"groupBy":[{"field":"startDate","type":"range","ranges":[{"startValue":"2020-01-01","endValue":"2020-06-01"}]},{"field":"city","type":"exact"}]}'

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 { "data": [ { "metrics": [ { "name": "min_tenure", "value": 1 }, { "name": "avg_tenure", "value": 3 } ], "group": { "startDate": { "startValue": "2020-01-01", "endValue": "2020-06-01" }, "city": "New York City" } }, { "metrics": [ { "name": "min_tenure", "value": 2 }, { "name": "avg_tenure", "value": 3 } ], "group": { "startDate": { "startValue": "2020-01-01", "endValue": "2020-06-01" }, "city": "San Francisco" } } ] }