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.
stringThe API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.
stringThe repository associated with a marketplace installation.
stringThe package name of the generated SDK.
objectRepresents the API POST body when loading an ObjectSet.
unionRepresents the definition of an ObjectSet in the Ontology.
objectunionRepresents the definition of an ObjectSet in the Ontology.
objectunionRepresents the definition of an ObjectSet in the Ontology.
stringThe name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
objectlist<ObjectRid>stringThe unique resource identifier of an object, useful for interacting with other Foundry APIs.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which returns objects with additional derived properties.
This feature is experimental and not yet generally available.
unionRepresents the definition of an ObjectSet in the Ontology.
map<DerivedPropertyApiName, DerivedPropertyDefinition>Map of the name of the derived property to return and its definition
stringThe name of the derived property that will be returned.
unionDefinition of a derived property.
objectDefinition for a selected property over a MethodObjectSet.
unionunionOperation on a selected property, can be an aggregation function or retrieval of a single selected property
objectComputes an approximate number of distinct values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the minimum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the average value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the maximum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the approximate percentile value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
numberobjectGets a single value of a property. Throws if the target object set is on the MANY side of the link and could explode the cardinality.
Use collectList or collectSet which will return a list of values in that case.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the total count of objects.
objectComputes the sum of values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all values of a property up to the specified limit. The maximum supported limit is 100, by default.
NOTE: A separate count aggregation should be used to determine the total count of values, to account for a possible truncation of the returned list.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectComputes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all distinct values of a property up to the specified limit. The maximum supported limit is 100.
NOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of values, to account for a possible truncation of the returned set.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectCasts an object set to a specified object type or interface type API name. Any object whose object type does not match the object type provided or implement the interface type provided will be dropped from the resulting object set. This is currently unsupported and an exception will be thrown if used.
stringAn object type or interface type API name.
unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which is the root of a MethodObjectSet definition.
This feature is experimental and not yet generally available.
objectstringobjectunionRepresents the definition of an ObjectSet in the Ontology.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectstringAn object set with objects that implement the interface with the given interface API name. The objects in the object set will only have properties that implement properties of the given interface. This is currently unsupported and an exception will be thrown if used.
objectCasts the objects in the object set to their base type and thus ensures objects are returned with all of their properties in the resulting object set, not just the properties that implement interface properties. This is currently unsupported and an exception will be thrown if used.
unionRepresents the definition of an ObjectSet in the Ontology.
objectstringstringThe name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
objectlist<ObjectRid>stringThe unique resource identifier of an object, useful for interacting with other Foundry APIs.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectunionRepresents the definition of an ObjectSet in the Ontology.
stringThe name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
objectlist<ObjectRid>stringThe unique resource identifier of an object, useful for interacting with other Foundry APIs.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which returns objects with additional derived properties.
This feature is experimental and not yet generally available.
unionRepresents the definition of an ObjectSet in the Ontology.
map<DerivedPropertyApiName, DerivedPropertyDefinition>Map of the name of the derived property to return and its definition
stringThe name of the derived property that will be returned.
unionDefinition of a derived property.
objectDefinition for a selected property over a MethodObjectSet.
unionunionOperation on a selected property, can be an aggregation function or retrieval of a single selected property
objectComputes an approximate number of distinct values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the minimum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the average value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the maximum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the approximate percentile value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
numberobjectGets a single value of a property. Throws if the target object set is on the MANY side of the link and could explode the cardinality.
Use collectList or collectSet which will return a list of values in that case.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the total count of objects.
objectComputes the sum of values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all values of a property up to the specified limit. The maximum supported limit is 100, by default.
NOTE: A separate count aggregation should be used to determine the total count of values, to account for a possible truncation of the returned list.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectComputes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all distinct values of a property up to the specified limit. The maximum supported limit is 100.
NOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of values, to account for a possible truncation of the returned set.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectCasts an object set to a specified object type or interface type API name. Any object whose object type does not match the object type provided or implement the interface type provided will be dropped from the resulting object set. This is currently unsupported and an exception will be thrown if used.
stringAn object type or interface type API name.
unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which is the root of a MethodObjectSet definition.
This feature is experimental and not yet generally available.
objectstringobjectunionRepresents the definition of an ObjectSet in the Ontology.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectstringAn object set with objects that implement the interface with the given interface API name. The objects in the object set will only have properties that implement properties of the given interface. This is currently unsupported and an exception will be thrown if used.
objectCasts the objects in the object set to their base type and thus ensures objects are returned with all of their properties in the resulting object set, not just the properties that implement interface properties. This is currently unsupported and an exception will be thrown if used.
unionRepresents the definition of an ObjectSet in the Ontology.
objectstringobjectObjectSet which returns objects with additional derived properties.
This feature is experimental and not yet generally available.
unionRepresents the definition of an ObjectSet in the Ontology.
objectunionRepresents the definition of an ObjectSet in the Ontology.
stringThe name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
objectlist<ObjectRid>stringThe unique resource identifier of an object, useful for interacting with other Foundry APIs.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which returns objects with additional derived properties.
This feature is experimental and not yet generally available.
unionRepresents the definition of an ObjectSet in the Ontology.
map<DerivedPropertyApiName, DerivedPropertyDefinition>Map of the name of the derived property to return and its definition
stringThe name of the derived property that will be returned.
unionDefinition of a derived property.
objectDefinition for a selected property over a MethodObjectSet.
unionunionOperation on a selected property, can be an aggregation function or retrieval of a single selected property
objectComputes an approximate number of distinct values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the minimum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the average value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the maximum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the approximate percentile value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
numberobjectGets a single value of a property. Throws if the target object set is on the MANY side of the link and could explode the cardinality.
Use collectList or collectSet which will return a list of values in that case.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the total count of objects.
objectComputes the sum of values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all values of a property up to the specified limit. The maximum supported limit is 100, by default.
NOTE: A separate count aggregation should be used to determine the total count of values, to account for a possible truncation of the returned list.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectComputes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all distinct values of a property up to the specified limit. The maximum supported limit is 100.
NOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of values, to account for a possible truncation of the returned set.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectCasts an object set to a specified object type or interface type API name. Any object whose object type does not match the object type provided or implement the interface type provided will be dropped from the resulting object set. This is currently unsupported and an exception will be thrown if used.
stringAn object type or interface type API name.
unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which is the root of a MethodObjectSet definition.
This feature is experimental and not yet generally available.
objectstringobjectunionRepresents the definition of an ObjectSet in the Ontology.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectstringAn object set with objects that implement the interface with the given interface API name. The objects in the object set will only have properties that implement properties of the given interface. This is currently unsupported and an exception will be thrown if used.
objectCasts the objects in the object set to their base type and thus ensures objects are returned with all of their properties in the resulting object set, not just the properties that implement interface properties. This is currently unsupported and an exception will be thrown if used.
unionRepresents the definition of an ObjectSet in the Ontology.
objectstringmap<DerivedPropertyApiName, DerivedPropertyDefinition>Map of the name of the derived property to return and its definition
stringThe name of the derived property that will be returned.
unionDefinition of a derived property.
objectDefinition for a selected property over a MethodObjectSet.
unionobjectunionRepresents the definition of an ObjectSet in the Ontology.
stringThe name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
objectlist<ObjectRid>stringThe unique resource identifier of an object, useful for interacting with other Foundry APIs.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which returns objects with additional derived properties.
This feature is experimental and not yet generally available.
unionRepresents the definition of an ObjectSet in the Ontology.
map<DerivedPropertyApiName, DerivedPropertyDefinition>Map of the name of the derived property to return and its definition
stringThe name of the derived property that will be returned.
unionDefinition of a derived property.
objectDefinition for a selected property over a MethodObjectSet.
unionunionOperation on a selected property, can be an aggregation function or retrieval of a single selected property
objectComputes an approximate number of distinct values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the minimum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the average value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the maximum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the approximate percentile value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
numberobjectGets a single value of a property. Throws if the target object set is on the MANY side of the link and could explode the cardinality.
Use collectList or collectSet which will return a list of values in that case.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the total count of objects.
objectComputes the sum of values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all values of a property up to the specified limit. The maximum supported limit is 100, by default.
NOTE: A separate count aggregation should be used to determine the total count of values, to account for a possible truncation of the returned list.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectComputes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all distinct values of a property up to the specified limit. The maximum supported limit is 100.
NOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of values, to account for a possible truncation of the returned set.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectCasts an object set to a specified object type or interface type API name. Any object whose object type does not match the object type provided or implement the interface type provided will be dropped from the resulting object set. This is currently unsupported and an exception will be thrown if used.
stringAn object type or interface type API name.
unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which is the root of a MethodObjectSet definition.
This feature is experimental and not yet generally available.
objectstringobjectunionRepresents the definition of an ObjectSet in the Ontology.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectstringAn object set with objects that implement the interface with the given interface API name. The objects in the object set will only have properties that implement properties of the given interface. This is currently unsupported and an exception will be thrown if used.
objectCasts the objects in the object set to their base type and thus ensures objects are returned with all of their properties in the resulting object set, not just the properties that implement interface properties. This is currently unsupported and an exception will be thrown if used.
unionRepresents the definition of an ObjectSet in the Ontology.
objectstringunionOperation on a selected property, can be an aggregation function or retrieval of a single selected property
objectComputes an approximate number of distinct values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the minimum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the average value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the maximum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the approximate percentile value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
numberobjectGets a single value of a property. Throws if the target object set is on the MANY side of the link and could explode the cardinality.
Use collectList or collectSet which will return a list of values in that case.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the total count of objects.
objectComputes the sum of values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all values of a property up to the specified limit. The maximum supported limit is 100, by default.
NOTE: A separate count aggregation should be used to determine the total count of values, to account for a possible truncation of the returned list.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectComputes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all distinct values of a property up to the specified limit. The maximum supported limit is 100.
NOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of values, to account for a possible truncation of the returned set.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectunionRepresents the definition of an ObjectSet in the Ontology.
stringThe name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
objectlist<ObjectRid>stringThe unique resource identifier of an object, useful for interacting with other Foundry APIs.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which returns objects with additional derived properties.
This feature is experimental and not yet generally available.
unionRepresents the definition of an ObjectSet in the Ontology.
map<DerivedPropertyApiName, DerivedPropertyDefinition>Map of the name of the derived property to return and its definition
stringThe name of the derived property that will be returned.
unionDefinition of a derived property.
objectDefinition for a selected property over a MethodObjectSet.
unionunionOperation on a selected property, can be an aggregation function or retrieval of a single selected property
objectComputes an approximate number of distinct values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the minimum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the average value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the maximum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the approximate percentile value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
numberobjectGets a single value of a property. Throws if the target object set is on the MANY side of the link and could explode the cardinality.
Use collectList or collectSet which will return a list of values in that case.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the total count of objects.
objectComputes the sum of values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all values of a property up to the specified limit. The maximum supported limit is 100, by default.
NOTE: A separate count aggregation should be used to determine the total count of values, to account for a possible truncation of the returned list.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectComputes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all distinct values of a property up to the specified limit. The maximum supported limit is 100.
NOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of values, to account for a possible truncation of the returned set.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectCasts an object set to a specified object type or interface type API name. Any object whose object type does not match the object type provided or implement the interface type provided will be dropped from the resulting object set. This is currently unsupported and an exception will be thrown if used.
stringAn object type or interface type API name.
unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which is the root of a MethodObjectSet definition.
This feature is experimental and not yet generally available.
objectstringobjectunionRepresents the definition of an ObjectSet in the Ontology.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectstringAn object set with objects that implement the interface with the given interface API name. The objects in the object set will only have properties that implement properties of the given interface. This is currently unsupported and an exception will be thrown if used.
objectCasts the objects in the object set to their base type and thus ensures objects are returned with all of their properties in the resulting object set, not just the properties that implement interface properties. This is currently unsupported and an exception will be thrown if used.
unionRepresents the definition of an ObjectSet in the Ontology.
objectstringobjectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectunionRepresents the definition of an ObjectSet in the Ontology.
stringThe name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
objectlist<ObjectRid>stringThe unique resource identifier of an object, useful for interacting with other Foundry APIs.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which returns objects with additional derived properties.
This feature is experimental and not yet generally available.
unionRepresents the definition of an ObjectSet in the Ontology.
map<DerivedPropertyApiName, DerivedPropertyDefinition>Map of the name of the derived property to return and its definition
stringThe name of the derived property that will be returned.
unionDefinition of a derived property.
objectDefinition for a selected property over a MethodObjectSet.
unionunionOperation on a selected property, can be an aggregation function or retrieval of a single selected property
objectComputes an approximate number of distinct values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the minimum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the average value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the maximum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the approximate percentile value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
numberobjectGets a single value of a property. Throws if the target object set is on the MANY side of the link and could explode the cardinality.
Use collectList or collectSet which will return a list of values in that case.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the total count of objects.
objectComputes the sum of values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all values of a property up to the specified limit. The maximum supported limit is 100, by default.
NOTE: A separate count aggregation should be used to determine the total count of values, to account for a possible truncation of the returned list.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectComputes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all distinct values of a property up to the specified limit. The maximum supported limit is 100.
NOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of values, to account for a possible truncation of the returned set.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectCasts an object set to a specified object type or interface type API name. Any object whose object type does not match the object type provided or implement the interface type provided will be dropped from the resulting object set. This is currently unsupported and an exception will be thrown if used.
stringAn object type or interface type API name.
unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which is the root of a MethodObjectSet definition.
This feature is experimental and not yet generally available.
objectstringobjectunionRepresents the definition of an ObjectSet in the Ontology.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectstringAn object set with objects that implement the interface with the given interface API name. The objects in the object set will only have properties that implement properties of the given interface. This is currently unsupported and an exception will be thrown if used.
objectCasts the objects in the object set to their base type and thus ensures objects are returned with all of their properties in the resulting object set, not just the properties that implement interface properties. This is currently unsupported and an exception will be thrown if used.
unionRepresents the definition of an ObjectSet in the Ontology.
objectstringobjectCasts an object set to a specified object type or interface type API name. Any object whose object type does not match the object type provided or implement the interface type provided will be dropped from the resulting object set. This is currently unsupported and an exception will be thrown if used.
stringAn object type or interface type API name.
unionRepresents the definition of an ObjectSet in the Ontology.
objectunionRepresents the definition of an ObjectSet in the Ontology.
stringThe name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
objectlist<ObjectRid>stringThe unique resource identifier of an object, useful for interacting with other Foundry APIs.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which returns objects with additional derived properties.
This feature is experimental and not yet generally available.
unionRepresents the definition of an ObjectSet in the Ontology.
map<DerivedPropertyApiName, DerivedPropertyDefinition>Map of the name of the derived property to return and its definition
stringThe name of the derived property that will be returned.
unionDefinition of a derived property.
objectDefinition for a selected property over a MethodObjectSet.
unionunionOperation on a selected property, can be an aggregation function or retrieval of a single selected property
objectComputes an approximate number of distinct values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the minimum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the average value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the maximum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the approximate percentile value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
numberobjectGets a single value of a property. Throws if the target object set is on the MANY side of the link and could explode the cardinality.
Use collectList or collectSet which will return a list of values in that case.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the total count of objects.
objectComputes the sum of values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all values of a property up to the specified limit. The maximum supported limit is 100, by default.
NOTE: A separate count aggregation should be used to determine the total count of values, to account for a possible truncation of the returned list.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectComputes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all distinct values of a property up to the specified limit. The maximum supported limit is 100.
NOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of values, to account for a possible truncation of the returned set.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectCasts an object set to a specified object type or interface type API name. Any object whose object type does not match the object type provided or implement the interface type provided will be dropped from the resulting object set. This is currently unsupported and an exception will be thrown if used.
stringAn object type or interface type API name.
unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which is the root of a MethodObjectSet definition.
This feature is experimental and not yet generally available.
objectstringobjectunionRepresents the definition of an ObjectSet in the Ontology.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectstringAn object set with objects that implement the interface with the given interface API name. The objects in the object set will only have properties that implement properties of the given interface. This is currently unsupported and an exception will be thrown if used.
objectCasts the objects in the object set to their base type and thus ensures objects are returned with all of their properties in the resulting object set, not just the properties that implement interface properties. This is currently unsupported and an exception will be thrown if used.
unionRepresents the definition of an ObjectSet in the Ontology.
objectstringobjectObjectSet which is the root of a MethodObjectSet definition.
This feature is experimental and not yet generally available.
objectstringobjectunionRepresents the definition of an ObjectSet in the Ontology.
objectunionRepresents the definition of an ObjectSet in the Ontology.
stringThe name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
objectlist<ObjectRid>stringThe unique resource identifier of an object, useful for interacting with other Foundry APIs.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which returns objects with additional derived properties.
This feature is experimental and not yet generally available.
unionRepresents the definition of an ObjectSet in the Ontology.
map<DerivedPropertyApiName, DerivedPropertyDefinition>Map of the name of the derived property to return and its definition
stringThe name of the derived property that will be returned.
unionDefinition of a derived property.
objectDefinition for a selected property over a MethodObjectSet.
unionunionOperation on a selected property, can be an aggregation function or retrieval of a single selected property
objectComputes an approximate number of distinct values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the minimum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the average value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the maximum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the approximate percentile value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
numberobjectGets a single value of a property. Throws if the target object set is on the MANY side of the link and could explode the cardinality.
Use collectList or collectSet which will return a list of values in that case.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the total count of objects.
objectComputes the sum of values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all values of a property up to the specified limit. The maximum supported limit is 100, by default.
NOTE: A separate count aggregation should be used to determine the total count of values, to account for a possible truncation of the returned list.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectComputes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all distinct values of a property up to the specified limit. The maximum supported limit is 100.
NOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of values, to account for a possible truncation of the returned set.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectCasts an object set to a specified object type or interface type API name. Any object whose object type does not match the object type provided or implement the interface type provided will be dropped from the resulting object set. This is currently unsupported and an exception will be thrown if used.
stringAn object type or interface type API name.
unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which is the root of a MethodObjectSet definition.
This feature is experimental and not yet generally available.
objectstringobjectunionRepresents the definition of an ObjectSet in the Ontology.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectstringAn object set with objects that implement the interface with the given interface API name. The objects in the object set will only have properties that implement properties of the given interface. This is currently unsupported and an exception will be thrown if used.
objectCasts the objects in the object set to their base type and thus ensures objects are returned with all of their properties in the resulting object set, not just the properties that implement interface properties. This is currently unsupported and an exception will be thrown if used.
unionRepresents the definition of an ObjectSet in the Ontology.
objectstringunionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectstringAn object set with objects that implement the interface with the given interface API name. The objects in the object set will only have properties that implement properties of the given interface. This is currently unsupported and an exception will be thrown if used.
objectCasts the objects in the object set to their base type and thus ensures objects are returned with all of their properties in the resulting object set, not just the properties that implement interface properties. This is currently unsupported and an exception will be thrown if used.
unionRepresents the definition of an ObjectSet in the Ontology.
objectunionRepresents the definition of an ObjectSet in the Ontology.
stringThe name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application.
objectlist<ObjectRid>stringThe unique resource identifier of an object, useful for interacting with other Foundry APIs.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which returns objects with additional derived properties.
This feature is experimental and not yet generally available.
unionRepresents the definition of an ObjectSet in the Ontology.
map<DerivedPropertyApiName, DerivedPropertyDefinition>Map of the name of the derived property to return and its definition
stringThe name of the derived property that will be returned.
unionDefinition of a derived property.
objectDefinition for a selected property over a MethodObjectSet.
unionunionOperation on a selected property, can be an aggregation function or retrieval of a single selected property
objectComputes an approximate number of distinct values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the minimum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the average value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the maximum value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the approximate percentile value for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
numberobjectGets a single value of a property. Throws if the target object set is on the MANY side of the link and could explode the cardinality.
Use collectList or collectSet which will return a list of values in that case.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectComputes the total count of objects.
objectComputes the sum of values for the provided field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all values of a property up to the specified limit. The maximum supported limit is 100, by default.
NOTE: A separate count aggregation should be used to determine the total count of values, to account for a possible truncation of the returned list.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectComputes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectLists all distinct values of a property up to the specified limit. The maximum supported limit is 100.
NOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of values, to account for a possible truncation of the returned set.
Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
integerMaximum number of values to collect. The maximum supported limit is 100.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectlist<ObjectSet>unionRepresents the definition of an ObjectSet in the Ontology.
objectCasts an object set to a specified object type or interface type API name. Any object whose object type does not match the object type provided or implement the interface type provided will be dropped from the resulting object set. This is currently unsupported and an exception will be thrown if used.
stringAn object type or interface type API name.
unionRepresents the definition of an ObjectSet in the Ontology.
objectObjectSet which is the root of a MethodObjectSet definition.
This feature is experimental and not yet generally available.
objectstringobjectunionRepresents the definition of an ObjectSet in the Ontology.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where at least 1 query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects where the specified field equals any of the provided values.
stringThe name of 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>anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field does not intersect the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains a point within the distance provided of the center point.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe coordinate point to use as the center of the distance query.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectA measurement of distance.
numberstring (enum)Enum values: MILLIMETERS, CENTIMETERS, METERS, KILOMETERS, INCHES, FEET, YARDS, MILES, NAUTICAL_MILES
objectReturns objects where the specified field contains a point within the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified array contains a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the query is not satisfied.
unionobjectReturns objects where the specified field intersects the bounding box provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectThe top left and bottom right coordinate points that make up the bounding box.
unionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberunionobjectlist<Coordinate>GeoJSon fundamental geometry construct.
A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element.
Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where every query is satisfied.
list<SearchJsonQueryV2>unionobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects based on the existence of the specified field.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
booleanobjectReturns 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.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringbooleanSetting fuzzy to true allows approximate matching in search queries that support it.
objectReturns objects where the specified field is greater than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectReturns objects where the specified field contains a point within the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field intersects the polygon provided.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
unionobjectlist<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.
numberlist<Coordinate>A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
numberobjectReturns objects where the specified field is less than or equal to a value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
objectReturns objects where the specified field starts with the provided value.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringobjectstringAn object set with objects that implement the interface with the given interface API name. The objects in the object set will only have properties that implement properties of the given interface. This is currently unsupported and an exception will be thrown if used.
objectCasts the objects in the object set to their base type and thus ensures objects are returned with all of their properties in the resulting object set, not just the properties that implement interface properties. This is currently unsupported and an exception will be thrown if used.
unionRepresents the definition of an ObjectSet in the Ontology.
objectstringobjectstringobjectSpecifies the ordering of search results by a field and an ordering direction.
list<SearchOrderingV2>objectstringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
stringSpecifies the ordering direction (can be either asc or desc)
list<SelectedPropertyApiName>stringBy 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.
stringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and use it to populate the pageToken field of the next request.
integerThe page size to use for the endpoint.
booleanA flag to exclude the retrieval of the __rid property.
Setting this to true may improve performance of this endpoint for object types in OSV2.
objectSuccess response.
list<OntologyObjectV2>The list of objects in the current Page.
map<PropertyApiName, PropertyValue>Represents an object in the Ontology.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
anyRepresents the value of a property in the following format.
| Type | JSON encoding | Example |
|---|---|---|
| Array | array | ["alpha", "bravo", "charlie"] |
| Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
| Boolean | boolean | true |
| Byte | number | 31 |
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Float | number | 3.14159265 |
| GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
| GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| Short | number | 8739 |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
stringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and use it to populate the pageToken field of the next request.
stringThe 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" \
-d '{"objectSet":{"type":"base","objectType":"Employee"},"pageSize":10000,"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"}'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
}
]
}