Search documentation
karat

+

K

User Documentation ↗

Rag Context Session

PUT/api/v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/ragContext
Warning

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.

Retrieve relevant context for a user message from the data sources configured for the session. This allows clients to pre-retrieve context for a user message before sending it to the Agent with the contextsOverride option when continuing a session, to allow any pre-processing of the context before sending it to the Agent.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:aip-agents-write.

Path parameters

agentRid
string

An RID identifying an AIP Agent created in AIP Agent Studio.

sessionRid
string

The Resource Identifier (RID) of the conversation session.

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Request body

RagContextSessionRequest
object
Hide child attributes

Hide child attributes

userInput
object

The user message to retrieve relevant context for from the configured Agent data sources.

Show child attributes

Show child attributes

text
string

The user message text.

parameterInputs
map<ParameterId, ParameterValue>
optional

Any parameter values to use for the context retrieval.

Show child attributes

Show child attributes

ParameterId
string

The unique identifier for a parameter, as configured in AIP Agent Studio.

ParameterValue
union

The value provided for a parameter configured on an Agent.

Show child attributes

Show child attributes

string
object
optional

A value passed for StringParameter parameter types.

Show child attributes

Show child attributes

value
string
objectSet
object
optional

A value passed for ObjectSetParameter parameter types.

Show child attributes

Show child attributes

objectSet
union

Represents the definition of an ObjectSet in the ontology.

Show child attributes

Show child attributes

reference
object
optional
Show child attributes

Show child attributes

reference
string

The Resource Identifier (RID) for an object set.

filter
object
optional
Show child attributes

Show child attributes

objectSet
union

Represents the definition of an ObjectSet in the ontology.

Show child attributes

Show child attributes

reference
object
optional
Show child attributes

Show child attributes

reference
string

The Resource Identifier (RID) for an object set.

filter
object
optional
Show child attributes

Show child attributes

objectSet
union

Represents the definition of an ObjectSet in the ontology.

where
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

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

withinBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

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

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
containsAnyTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
withinPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
in
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

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

withinBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

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

withinBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

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

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
containsAnyTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
withinPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
intersectsBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

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

withinBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

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

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
containsAnyTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
withinPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

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

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
containsAnyTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
withinPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
searchAround
object
optional
Show child attributes

Show child attributes

objectSet
union

Represents the definition of an ObjectSet in the ontology.

link
string

The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager.

static
object
optional
Show child attributes

Show child attributes

objects
list<ObjectRid>
optional
Show child attributes

Show child attributes

ObjectRid
string

The Resource Identifier (RID) for an ontology object instance.

intersect
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

subtract
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

union
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

base
object
optional
Show child attributes

Show child attributes

objectType
string

The API name of the object type.

where
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

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

withinBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

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

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
containsAnyTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
withinPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
in
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

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

withinBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

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

withinBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

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

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
containsAnyTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
withinPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
intersectsBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

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

withinBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

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

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
containsAnyTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
withinPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

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

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
containsAnyTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
withinPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
searchAround
object
optional
Show child attributes

Show child attributes

objectSet
union

Represents the definition of an ObjectSet in the ontology.

Show child attributes

Show child attributes

reference
object
optional
Show child attributes

Show child attributes

reference
string

The Resource Identifier (RID) for an object set.

filter
object
optional
Show child attributes

Show child attributes

objectSet
union

Represents the definition of an ObjectSet in the ontology.

where
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

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

withinBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

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

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
containsAnyTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
withinPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
in
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

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

withinBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

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

withinBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

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

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
containsAnyTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
withinPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
intersectsBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

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

withinBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

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

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
containsAnyTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
withinPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

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

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
containsAnyTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
withinPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
searchAround
object
optional
Show child attributes

Show child attributes

objectSet
union

Represents the definition of an ObjectSet in the ontology.

link
string

The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager.

static
object
optional
Show child attributes

Show child attributes

objects
list<ObjectRid>
optional
Show child attributes

Show child attributes

ObjectRid
string

The Resource Identifier (RID) for an ontology object instance.

intersect
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

subtract
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

union
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

base
object
optional
Show child attributes

Show child attributes

objectType
string

The API name of the object type.

link
string

The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager.

static
object
optional
Show child attributes

Show child attributes

objects
list<ObjectRid>
optional
Show child attributes

Show child attributes

ObjectRid
string

The Resource Identifier (RID) for an ontology object instance.

intersect
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

Show child attributes

Show child attributes

reference
object
optional
Show child attributes

Show child attributes

reference
string

The Resource Identifier (RID) for an object set.

filter
object
optional
Show child attributes

Show child attributes

objectSet
union

Represents the definition of an ObjectSet in the ontology.

where
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

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

withinBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

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

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
containsAnyTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
withinPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
in
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

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

withinBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

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

withinBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

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

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
containsAnyTerm
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
fuzzy
boolean
optional

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

gte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
withinPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
string
intersectsBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

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

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

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

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

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

Show child attributes

Show child attributes

field
string

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

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

Returns objects where the specified field is equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gt
object
optional

Returns objects where the specified field is greater than a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

Returns objects where the specified field contains a point within the distance provided of the center point.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The coordinate point to use as the center of the distance query.

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES

withinBoundingBox
object
optional

Returns objects where the specified field contains a point within the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

Returns objects where the specified field intersects the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
containsAnyTerm
object
optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gte
object
optional

Returns objects where the specified field is greater than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
withinPolygon
object
optional

Returns objects where the specified field contains a point within the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

Returns objects where the specified field is less than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

Returns objects where the specified field starts with the provided value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
containsAnyTerm
object
optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gte
object
optional

Returns objects where the specified field is greater than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
withinPolygon
object
optional

Returns objects where the specified field contains a point within the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

Returns objects where the specified field is less than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

Returns objects where the specified field starts with the provided value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
searchAround
object
optional
Show child attributes

Show child attributes

objectSet
union

Represents the definition of an ObjectSet in the ontology.

link
string

The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager.

static
object
optional
Show child attributes

Show child attributes

objects
list<ObjectRid>
optional
Show child attributes

Show child attributes

ObjectRid
string

The Resource Identifier (RID) for an ontology object instance.

intersect
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

subtract
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

union
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

base
object
optional
Show child attributes

Show child attributes

objectType
string

The API name of the object type.

subtract
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

Show child attributes

Show child attributes

reference
object
optional
Show child attributes

Show child attributes

reference
string

The Resource Identifier (RID) for an object set.

filter
object
optional
Show child attributes

Show child attributes

objectSet
union

Represents the definition of an ObjectSet in the ontology.

where
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

Returns objects where the specified field equals any of the provided values.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

Returns objects where the specified field does not intersect the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

Returns objects where the specified field is less than a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

Returns objects where the specified field does not intersect the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

Returns objects where the specified field is equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gt
object
optional

Returns objects where the specified field is greater than a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

Returns objects where the specified field contains a point within the distance provided of the center point.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The coordinate point to use as the center of the distance query.

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES

withinBoundingBox
object
optional

Returns objects where the specified field contains a point within the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

Returns objects where the specified field intersects the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
containsAnyTerm
object
optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gte
object
optional

Returns objects where the specified field is greater than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
withinPolygon
object
optional

Returns objects where the specified field contains a point within the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

Returns objects where the specified field is less than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

Returns objects where the specified field starts with the provided value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
in
object
optional

Returns objects where the specified field equals any of the provided values.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

Returns objects where the specified field does not intersect the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

Returns objects where the specified field is less than a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

Returns objects where the specified field does not intersect the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

Returns objects where the specified field is equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gt
object
optional

Returns objects where the specified field is greater than a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

Returns objects where the specified field contains a point within the distance provided of the center point.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The coordinate point to use as the center of the distance query.

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES

withinBoundingBox
object
optional

Returns objects where the specified field contains a point within the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

Returns objects where the specified field equals any of the provided values.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

Returns objects where the specified field does not intersect the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

Returns objects where the specified field is less than a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

Returns objects where the specified field does not intersect the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

Returns objects where the specified field is equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gt
object
optional

Returns objects where the specified field is greater than a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

Returns objects where the specified field contains a point within the distance provided of the center point.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The coordinate point to use as the center of the distance query.

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES

withinBoundingBox
object
optional

Returns objects where the specified field contains a point within the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

Returns objects where the specified field intersects the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
containsAnyTerm
object
optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gte
object
optional

Returns objects where the specified field is greater than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
withinPolygon
object
optional

Returns objects where the specified field contains a point within the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

Returns objects where the specified field is less than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

Returns objects where the specified field starts with the provided value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
intersectsBoundingBox
object
optional

Returns objects where the specified field intersects the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

Returns objects where the specified field equals any of the provided values.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

Returns objects where the specified field does not intersect the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

Returns objects where the specified field is less than a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

Returns objects where the specified field does not intersect the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

Returns objects where the specified field is equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gt
object
optional

Returns objects where the specified field is greater than a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

Returns objects where the specified field contains a point within the distance provided of the center point.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The coordinate point to use as the center of the distance query.

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES

withinBoundingBox
object
optional

Returns objects where the specified field contains a point within the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

Returns objects where the specified field intersects the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
containsAnyTerm
object
optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gte
object
optional

Returns objects where the specified field is greater than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
withinPolygon
object
optional

Returns objects where the specified field contains a point within the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

Returns objects where the specified field is less than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

Returns objects where the specified field starts with the provided value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
containsAnyTerm
object
optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gte
object
optional

Returns objects where the specified field is greater than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
withinPolygon
object
optional

Returns objects where the specified field contains a point within the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

Returns objects where the specified field is less than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

Returns objects where the specified field starts with the provided value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
searchAround
object
optional
Show child attributes

Show child attributes

objectSet
union

Represents the definition of an ObjectSet in the ontology.

link
string

The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager.

static
object
optional
Show child attributes

Show child attributes

objects
list<ObjectRid>
optional
Show child attributes

Show child attributes

ObjectRid
string

The Resource Identifier (RID) for an ontology object instance.

intersect
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

subtract
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

union
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

base
object
optional
Show child attributes

Show child attributes

objectType
string

The API name of the object type.

union
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

Show child attributes

Show child attributes

reference
object
optional
Show child attributes

Show child attributes

reference
string

The Resource Identifier (RID) for an object set.

filter
object
optional
Show child attributes

Show child attributes

objectSet
union

Represents the definition of an ObjectSet in the ontology.

where
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

Returns objects where the specified field equals any of the provided values.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

Returns objects where the specified field does not intersect the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

Returns objects where the specified field is less than a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

Returns objects where the specified field does not intersect the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

Returns objects where the specified field is equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gt
object
optional

Returns objects where the specified field is greater than a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

Returns objects where the specified field contains a point within the distance provided of the center point.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The coordinate point to use as the center of the distance query.

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES

withinBoundingBox
object
optional

Returns objects where the specified field contains a point within the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

Returns objects where the specified field intersects the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
containsAnyTerm
object
optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gte
object
optional

Returns objects where the specified field is greater than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
withinPolygon
object
optional

Returns objects where the specified field contains a point within the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

Returns objects where the specified field is less than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

Returns objects where the specified field starts with the provided value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
in
object
optional

Returns objects where the specified field equals any of the provided values.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

Returns objects where the specified field does not intersect the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

Returns objects where the specified field is less than a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

Returns objects where the specified field does not intersect the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

Returns objects where the specified field is equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gt
object
optional

Returns objects where the specified field is greater than a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

Returns objects where the specified field contains a point within the distance provided of the center point.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The coordinate point to use as the center of the distance query.

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES

withinBoundingBox
object
optional

Returns objects where the specified field contains a point within the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

Returns objects where the specified field equals any of the provided values.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

Returns objects where the specified field does not intersect the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

Returns objects where the specified field is less than a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

Returns objects where the specified field does not intersect the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

Returns objects where the specified field is equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gt
object
optional

Returns objects where the specified field is greater than a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

Returns objects where the specified field contains a point within the distance provided of the center point.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The coordinate point to use as the center of the distance query.

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES

withinBoundingBox
object
optional

Returns objects where the specified field contains a point within the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

Returns objects where the specified field intersects the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
containsAnyTerm
object
optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gte
object
optional

Returns objects where the specified field is greater than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
withinPolygon
object
optional

Returns objects where the specified field contains a point within the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

Returns objects where the specified field is less than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

Returns objects where the specified field starts with the provided value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
intersectsBoundingBox
object
optional

Returns objects where the specified field intersects the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
Show child attributes

Show child attributes

or
object
optional

Returns objects where at least 1 query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
in
object
optional

Returns objects where the specified field equals any of the provided values.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
list<PropertyValue>
optional
Show child attributes

Show child attributes

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectPolygon
object
optional

Returns objects where the specified field does not intersect the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lt
object
optional

Returns objects where the specified field is less than a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
doesNotIntersectBoundingBox
object
optional

Returns objects where the specified field does not intersect the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
eq
object
optional

Returns objects where the specified field is equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTerms
object
optional

Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gt
object
optional

Returns objects where the specified field is greater than a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
withinDistanceOf
object
optional

Returns objects where the specified field contains a point within the distance provided of the center point.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The coordinate point to use as the center of the distance query.

Show child attributes

Show child attributes

center
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
distance
object

A measurement of distance.

Show child attributes

Show child attributes

value
number
unit
string (enum)

Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES

withinBoundingBox
object
optional

Returns objects where the specified field contains a point within the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
contains
object
optional

Returns objects where the specified array contains a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
not
object
optional

Returns objects where the query is not satisfied.

Show child attributes

Show child attributes

value
union
intersectsBoundingBox
object
optional

Returns objects where the specified field intersects the bounding box provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
object

The top left and bottom right coordinate points that make up the bounding box.

Show child attributes

Show child attributes

topLeft
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
bottomRight
union
Show child attributes

Show child attributes

Point
object
optional
Show child attributes

Show child attributes

coordinates
list<Coordinate>
optional

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
and
object
optional

Returns objects where every query is satisfied.

Show child attributes

Show child attributes

value
list<SearchJsonQueryV2>
optional
Show child attributes

Show child attributes

SearchJsonQueryV2
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
containsAnyTerm
object
optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gte
object
optional

Returns objects where the specified field is greater than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
withinPolygon
object
optional

Returns objects where the specified field contains a point within the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

Returns objects where the specified field is less than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

Returns objects where the specified field starts with the provided value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
isNull
object
optional

Returns objects based on the existence of the specified field.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
boolean
containsAllTermsInOrderPrefixLastTerm
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
containsAnyTerm
object
optional

Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
fuzzy
boolean
optional

Setting fuzzy to true allows approximate matching in search queries that support it.

gte
object
optional

Returns objects where the specified field is greater than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
containsAllTermsInOrder
object
optional

Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
withinPolygon
object
optional

Returns objects where the specified field contains a point within the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
intersectsPolygon
object
optional

Returns objects where the specified field intersects the polygon provided.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
union
Show child attributes

Show child attributes

Show child attributes

Show child attributes

coordinates
list<LinearRing>
optional
Show child attributes

Show child attributes

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.

Show child attributes

Show child attributes

Position
list<Coordinate>

GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.

Show child attributes

Show child attributes

Coordinate
number
bbox
list<Coordinate>
optional

A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. See https://datatracker.ietf.org/doc/html/rfc7946#section-5.

Show child attributes

Show child attributes

Coordinate
number
lte
object
optional

Returns objects where the specified field is less than or equal to a value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
startsWith
object
optional

Returns objects where the specified field starts with the provided value.

Show child attributes

Show child attributes

field
string

The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.

value
string
searchAround
object
optional
Show child attributes

Show child attributes

objectSet
union

Represents the definition of an ObjectSet in the ontology.

link
string

The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager.

static
object
optional
Show child attributes

Show child attributes

objects
list<ObjectRid>
optional
Show child attributes

Show child attributes

ObjectRid
string

The Resource Identifier (RID) for an ontology object instance.

intersect
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

subtract
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

union
object
optional
Show child attributes

Show child attributes

objectSets
list<ObjectSet>
optional
Show child attributes

Show child attributes

ObjectSet
union

Represents the definition of an ObjectSet in the ontology.

base
object
optional
Show child attributes

Show child attributes

objectType
string

The API name of the object type.

base
object
optional
Show child attributes

Show child attributes

objectType
string

The API name of the object type.

ontology
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.

Response body

AgentSessionRagContextResponse
object

Context retrieved from an Agent's configured context data sources which was relevant to the supplied user message.

Hide child attributes

Hide child attributes

objectContexts
list<ObjectContext>
optional
Show child attributes

Show child attributes

ObjectContext
object

Details of relevant retrieved object instances for a user's message to include as additional context in the prompt to the Agent.

Show child attributes

Show child attributes

objectRids
list<ObjectRid>
optional

The RIDs of the relevant object instances to include in the prompt.

Show child attributes

Show child attributes

ObjectRid
string

The Resource Identifier (RID) for an ontology object instance.

propertyTypeRids
list<PropertyTypeRid>
optional

The RIDs of the property types for the given objects to include in the prompt.

Show child attributes

Show child attributes

PropertyTypeRid
string

The RID for a property type from an ontology object.

Examples

Request

Copied!
1 2 3 4 5 curl -X PUT \ -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/ragContext?preview=true" \ -d '{"userInput":{"text":"What is the status of my order?"}}'

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 { "objectContexts": [ { "objectRids": [ "ri.phonograph2-objects.main.object.48668bf6-8878-48d2-b8f8-f0017593feb5" ], "propertyTypeRids": [ "ri.ontology.main.property.7899aeb4-a389-4f2e-a0fd-e7193a4f6cb1" ] } ] }