Load the ontology objects present in the ObjectSet
from the provided object set definition.
For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects
are available, attempting to load another page will result in an ObjectsExceededLimit
error being returned. There is no limit on Object Storage V2 backed objects.
Note that null value properties will not be returned.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontologies-read
.
string
The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.
string
The repository associated with a marketplace installation.
string
The package name of the generated SDK.
object
Represents the API POST body when loading an ObjectSet
.
union
Represents the definition of an ObjectSet
in the Ontology
.
object
string
object
union
Represents the definition of an ObjectSet
in the Ontology
.
object
string
object
union
Represents the definition of an ObjectSet
in the Ontology
.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
union
Represents the definition of an ObjectSet
in the Ontology
.
string
The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
object
list<ObjectRid>
string
The unique resource identifier of an object, useful for interacting with other Foundry APIs.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
string
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
union
Represents the definition of an ObjectSet
in the Ontology
.
object
string
object
union
Represents the definition of an ObjectSet
in the Ontology
.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
union
Represents the definition of an ObjectSet
in the Ontology
.
string
The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
object
list<ObjectRid>
string
The unique resource identifier of an object, useful for interacting with other Foundry APIs.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
string
string
The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
object
list<ObjectRid>
string
The unique resource identifier of an object, useful for interacting with other Foundry APIs.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
string
object
union
Represents the definition of an ObjectSet
in the Ontology
.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
union
Represents the definition of an ObjectSet
in the Ontology
.
string
The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
object
list<ObjectRid>
string
The unique resource identifier of an object, useful for interacting with other Foundry APIs.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
string
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
string
object
union
Represents the definition of an ObjectSet
in the Ontology
.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
union
Represents the definition of an ObjectSet
in the Ontology
.
string
The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
object
list<ObjectRid>
string
The unique resource identifier of an object, useful for interacting with other Foundry APIs.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
string
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
string
object
union
Represents the definition of an ObjectSet
in the Ontology
.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects where the specified field equals any of the provided values.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
list<PropertyValue>
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field does not intersect the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains a point within the distance provided of the center point.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The coordinate point to use as the center of the distance query.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
A measurement of distance.
number
string
(enum)Enum values: MILLIMETERS
, CENTIMETERS
, METERS
, KILOMETERS
, INCHES
, FEET
, YARDS
, MILES
, NAUTICAL_MILES
object
Returns objects where the specified field contains a point within the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified array contains a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the query is not satisfied.
union
object
Returns objects where the specified field intersects the bounding box provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
object
The top left and bottom right coordinate points that make up the bounding box.
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
union
object
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where every query is satisfied.
list<SearchJsonQueryV2>
union
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects based on the existence of the specified field.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
boolean
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
boolean
Setting fuzzy to true
allows approximate matching in search queries that support it.
object
Returns objects where the specified field is greater than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
Returns objects where the specified field contains a point within the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field intersects the polygon provided.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
union
object
list<LinearRing>
list<Position>
A linear ring is a closed LineString with four or more positions.
The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical.
A linear ring is the boundary of a surface or the boundary of a hole in a surface.
A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
list<Coordinate>
GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
number
list<Coordinate>
A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
number
object
Returns objects where the specified field is less than or equal to a value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
object
Returns objects where the specified field starts with the provided value.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
object
union
Represents the definition of an ObjectSet
in the Ontology
.
string
The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
object
list<ObjectRid>
string
The unique resource identifier of an object, useful for interacting with other Foundry APIs.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
list<ObjectSet>
union
Represents the definition of an ObjectSet
in the Ontology
.
object
string
object
string
object
Specifies the ordering of search results by a field and an ordering direction.
list<SearchOrderingV2>
object
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
Specifies the ordering direction (can be either asc
or desc
)
list<SelectedPropertyApiName>
string
By default, anytime an object is requested, every property belonging to that object is returned.
The response can be filtered to only include certain properties using the properties
query parameter.
Properties to include can be specified in one of two ways.
properties
query parameter
properties={property1ApiName},{property2ApiName}
properties
query parameters.
properties={property1ApiName}&properties={property2ApiName}
The primary key of the object will always be returned even if it wasn't specified in the properties
values.
Unknown properties specified in the properties
list will result in a PropertiesNotFound
error.
To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string
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 populate the next request's pageToken
field with it.
integer
The page size to use for the endpoint.
boolean
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.
object
Success response.
list<OntologyObjectV2>
The list of objects in the current Page.
map<PropertyApiName, PropertyValue>
Represents an object in the Ontology.
string
The name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
any
Represents the value of a property in the following format.
Type | JSON encoding | Example |
---|---|---|
Array | array | ["alpha", "bravo", "charlie"] |
Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
Boolean | boolean | true |
Byte | number | 31 |
Date | ISO 8601 extended local date string | "2021-05-01" |
Decimal | string | "2.718281828" |
Double | number | 3.14159265 |
Float | number | 3.14159265 |
GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
Integer | number | 238940 |
Long | string | "58319870951433" |
Short | number | 8739 |
String | string | "Call me Ishmael" |
Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
string
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 populate the next request's pageToken
field with it.
string
The total number of items across all pages.
1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/ontologies/palantir/objectSets/loadObjects?artifactRepository=&packageName=" \
-d '{"objectSet":{"type":"base","objectType":"Employee"},"pageSize":10000,"nextPageToken":"v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv"}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
"data": [
{
"__rid": "ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851",
"__primaryKey": 50030,
"__apiName": "Employee",
"employeeId": 50030,
"firstName": "John",
"lastName": "Smith",
"age": 21
},
{
"__rid": "ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61",
"__primaryKey": 20090,
"__apiName": "Employee",
"employeeId": 20090,
"firstName": "John",
"lastName": "Haymore",
"age": 27
}
]
}