This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true
to the request query parameters.
Continue a conversation session with an Agent, or add the first exchange to a session after creation.
Adds a new exchange to the session with the provided inputs, and generates a response from the Agent.
Returns a stream of the Agent response text (formatted using markdown) for clients to consume as the response is generated.
On completion of the streamed response, clients can load the full details of the exchange that was added to the session by reloading the session content.
Streamed exchanges also support cancellation; see cancel
for details.
Concurrent requests to continue the same session are not supported.
Clients should wait to receive a response, or cancel the in-progress exchange, before sending the next message.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:aip-agents-write
.
string
An RID identifying an AIP Agent created in AIP Agent Studio.
string
The Resource Identifier (RID) of the conversation session.
object
object
The user message for the Agent to respond to.
string
The user message text.
map<ParameterId, ParameterValue>
Any supplied parameter values to pass to the Agent for the exchange.
string
The unique identifier for a parameter, as configured in AIP Agent Studio.
union
The value provided for a parameter configured on an Agent.
object
A value passed for StringParameter
parameter types.
string
object
A value passed for ObjectSetParameter
parameter types.
union
Represents the definition of an ObjectSet
in the ontology.
object
string
The Resource Identifier (RID) for an object set.
object
union
Represents the definition of an ObjectSet
in the ontology.
object
string
The Resource Identifier (RID) for an object set.
object
union
Represents the definition of an ObjectSet
in the ontology.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
union
Represents the definition of an ObjectSet
in the ontology.
string
The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager.
object
list<ObjectRid>
string
The Resource Identifier (RID) for an ontology object instance.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
string
The API name of the object type.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
union
Represents the definition of an ObjectSet
in the ontology.
object
string
The Resource Identifier (RID) for an object set.
object
union
Represents the definition of an ObjectSet
in the ontology.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
union
Represents the definition of an ObjectSet
in the ontology.
string
The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager.
object
list<ObjectRid>
string
The Resource Identifier (RID) for an ontology object instance.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
string
The API name of the object type.
string
The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager.
object
list<ObjectRid>
string
The Resource Identifier (RID) for an ontology object instance.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
string
The Resource Identifier (RID) for an object set.
object
union
Represents the definition of an ObjectSet
in the ontology.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
union
Represents the definition of an ObjectSet
in the ontology.
string
The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager.
object
list<ObjectRid>
string
The Resource Identifier (RID) for an ontology object instance.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
string
The API name of the object type.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
string
The Resource Identifier (RID) for an object set.
object
union
Represents the definition of an ObjectSet
in the ontology.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
union
Represents the definition of an ObjectSet
in the ontology.
string
The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager.
object
list<ObjectRid>
string
The Resource Identifier (RID) for an ontology object instance.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
string
The API name of the object type.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
string
The Resource Identifier (RID) for an object set.
object
union
Represents the definition of an ObjectSet
in the ontology.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
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.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field does not intersect the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field contains a point within the distance provided of the center point.
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.
object
The coordinate point to use as the center of the distance query.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified array contains a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
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.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
union
object
See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 for more information.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
Returns objects based on the existence of the specified 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.
boolean
object
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.
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.
string
object
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.
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.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
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.
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.
string
object
Returns objects where the specified field contains a point within the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field intersects the polygon provided.
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.
union
object
list<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. See https://tools.ietf.org/html/rfc7946#section-3.1.6.
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.
number
list<Coordinate>
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. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.
number
object
Returns objects where the specified field is less than or equal to a value.
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.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 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. |
object
Returns objects where the specified field starts with the provided value.
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.
string
object
union
Represents the definition of an ObjectSet
in the ontology.
string
The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager.
object
list<ObjectRid>
string
The Resource Identifier (RID) for an ontology object instance.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the ontology.
object
string
The API name of the object type.
object
string
The API name of the object type.
string
The API name of the Ontology for the provided ObjectSet
.
To find the API name, use the List ontologies
endpoint or check the Ontology Manager.
list<InputContext>
If set, automatic context retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session.
union
Custom retrieved context to provide to an Agent for continuing a session.
object
Details of relevant retrieved object instances for a user's message to include as additional context in the prompt to the Agent.
list<ObjectRid>
The RIDs of the relevant object instances to include in the prompt.
string
The Resource Identifier (RID) for an ontology object instance.
list<PropertyTypeRid>
The RIDs of the property types for the given objects to include in the prompt.
string
The RID for a property type from an ontology object.
string
A client-generated Universally Unique Identifier (UUID) to identify the message, which the client can use to cancel the exchange before the streaming response is complete.
1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/aipAgents/agents/ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1/sessions/ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6/streamingContinue?preview=true" \
-d '{"messageId":"00f8412a-c29d-4063-a417-8052825285a5","userInput":{"text":"What is the status of my order?"}}'