Search documentation
karat

+

K

User Documentation ↗

Search Objects

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

Search for objects in the specified ontology and object type. The request body is used to filter objects based on the specified query. The supported queries are:

Query typeDescriptionSupported Types
ltThe provided property is less than the provided value.number, string, date, timestamp
gtThe provided property is greater than the provided value.number, string, date, timestamp
lteThe provided property is less than or equal to the provided value.number, string, date, timestamp
gteThe provided property is greater than or equal to the provided value.number, string, date, timestamp
eqThe provided property is exactly equal to the provided value.number, string, date, timestamp
isNullThe provided property is (or is not) null.all
containsThe provided property contains the provided value.array
notThe sub-query does not match.N/A (applied on a query)
andAll the sub-queries match.N/A (applied on queries)
orAt least one of the sub-queries match.N/A (applied on queries)
startsWithThe provided property starts with the provided term.string
containsAllTermsInOrderPrefixLastTermThe provided property contains all the terms provided in order. The last term can be a partial prefix match.string
containsAllTermsInOrderThe provided property contains the provided term as a substring.string
containsAnyTermThe provided property contains at least one of the terms separated by whitespace.string
containsAllTermsThe provided property contains all the terms separated by whitespace.string

Queries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (?!,:;-[](){}'"~). Periods (.) on their own are ignored. Partial terms are not matched by terms filters except where explicitly noted.

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

Path parameters

ontology
string

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

objectType
string

The API name of the object type. To find the API name, use the List object types endpoint or check the Ontology Manager.

Query parameters

artifactRepository
string
optional

The repository associated with a marketplace installation.

packageName
string
optional

The package name of the generated SDK.

Request body

SearchObjectsRequestV2
object
Hide child attributes

Hide child attributes

where
union
optional
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

Polygon
object
optional
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.

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.

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.

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.

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.

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.

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.

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.

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.

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

Polygon
object
optional
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.

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.

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

Polygon
object
optional
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.

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.

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

Polygon
object
optional
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.

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.

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.

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.

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.

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.

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.

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

Polygon
object
optional
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.

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.

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.

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.

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.

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.

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.

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.

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.

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

Polygon
object
optional
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.

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.

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

Polygon
object
optional
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.

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.

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.

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.

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

Polygon
object
optional
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.

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.

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.

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.

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.

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.

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.

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.

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.

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

Polygon
object
optional
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.

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.

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

Polygon
object
optional
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.

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.

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

Polygon
object
optional
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.

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.

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

Polygon
object
optional
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.

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.

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
orderBy
object
optional

Specifies the ordering of search results by a field and an ordering direction.

Show child attributes

Show child attributes

fields
list<SearchOrderingV2>
optional
Show child attributes

Show child attributes

SearchOrderingV2
object
Show child attributes

Show child attributes

field
string

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

direction
string
optional

Specifies the ordering direction (can be either asc or desc)

pageSize
integer
optional

The page size to use for the endpoint.

pageToken
string
optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

select
list<PropertyApiName>
optional

The API names of the object type properties to include in the response.

Show child attributes

Show child attributes

PropertyApiName
string

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

excludeRid
boolean
optional

A flag to exclude the retrieval of the __rid property. Setting this to true may improve performance of this endpoint for object types in OSV2.

Response body

SearchObjectsResponseV2
object

Success response.

Hide child attributes

Hide child attributes

data
list<OntologyObjectV2>
optional
Show child attributes

Show child attributes

OntologyObjectV2
map<PropertyApiName, PropertyValue>

Represents an object in the Ontology.

Show child attributes

Show child attributes

PropertyApiName
string

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

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.

nextPageToken
string
optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

totalCount
string

The total number of items across all pages.

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ -H "Content-type: application/json" \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/ontologies/palantir/objects/employee/search" \ -d '{"where":{"type":"eq","field":"age","value":21}}'

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 { "data": [ { "__rid": "ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb", "__primaryKey": 1000, "__apiName": "Employee", "employeeId": 1000, "lastName": "smith", "firstName": "john", "age": 21 } ] }