API Reference

Search Objects

POST/api/v1/ontologies/{ontologyRid}/objects/{objectType}/search

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

Query type	Description	Supported Types
lt	The provided property is less than the provided value.	number, string, date, timestamp
gt	The provided property is greater than the provided value.	number, string, date, timestamp
lte	The provided property is less than or equal to the provided value.	number, string, date, timestamp
gte	The provided property is greater than or equal to the provided value.	number, string, date, timestamp
eq	The provided property is exactly equal to the provided value.	number, string, date, timestamp
isNull	The provided property is (or is not) null.	all
contains	The provided property contains the provided value.	array
not	The sub-query does not match.	N/A (applied on a query)
and	All the sub-queries match.	N/A (applied on queries)
or	At least one of the sub-queries match.	N/A (applied on queries)
prefix	The provided property starts with the provided term.	string
phrase	The provided property contains the provided term as a substring.	string
anyTerm	The provided property contains at least one of the terms separated by whitespace.	string
allTerms	The provided property contains all the terms separated by whitespace.	string

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

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

Path parameters

ontologyRid

string

The unique Resource Identifier (RID) of the Ontology that contains the objects.

objectType

string

The type of the requested objects.

Request body

SearchObjectsRequest

object

Hide child attributes

query

union

Show child attributes

object

optional

Returns objects where at least 1 query is satisfied.

Show child attributes

value

list<SearchJsonQuery>

optional

Show child attributes

SearchJsonQuery

union

Show child attributes

object

optional

Returns objects where at least 1 query is satisfied.

Show child attributes

value

list<SearchJsonQuery>

optional

Show child attributes

SearchJsonQuery

union

prefix

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

allTerms

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

fuzzy

boolean

optional

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

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

contains

object

optional

Returns objects where the specified array contains a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

not

object

optional

Returns objects where the query is not satisfied.

Show child attributes

value

union

phrase

object

optional

Returns objects where the specified field contains the provided value as a substring.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

and

object

optional

Returns objects where every query is satisfied.

Show child attributes

value

list<SearchJsonQuery>

optional

Show child attributes

SearchJsonQuery

union

isNull

object

optional

Returns objects based on the existence of the specified field.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

boolean

gte

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

anyTerm

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

fuzzy

boolean

optional

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

lte

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

prefix

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

allTerms

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

fuzzy

boolean

optional

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

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

contains

object

optional

Returns objects where the specified array contains a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

not

object

optional

Returns objects where the query is not satisfied.

Show child attributes

value

union

Show child attributes

object

optional

Returns objects where at least 1 query is satisfied.

Show child attributes

value

list<SearchJsonQuery>

optional

Show child attributes

SearchJsonQuery

union

prefix

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

allTerms

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

fuzzy

boolean

optional

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

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

contains

object

optional

Returns objects where the specified array contains a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

not

object

optional

Returns objects where the query is not satisfied.

Show child attributes

value

union

phrase

object

optional

Returns objects where the specified field contains the provided value as a substring.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

and

object

optional

Returns objects where every query is satisfied.

Show child attributes

value

list<SearchJsonQuery>

optional

Show child attributes

SearchJsonQuery

union

isNull

object

optional

Returns objects based on the existence of the specified field.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

boolean

gte

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

anyTerm

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

fuzzy

boolean

optional

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

lte

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

phrase

object

optional

Returns objects where the specified field contains the provided value as a substring.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

and

object

optional

Returns objects where every query is satisfied.

Show child attributes

value

list<SearchJsonQuery>

optional

Show child attributes

SearchJsonQuery

union

Show child attributes

object

optional

Returns objects where at least 1 query is satisfied.

Show child attributes

value

list<SearchJsonQuery>

optional

Show child attributes

SearchJsonQuery

union

prefix

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

allTerms

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

fuzzy

boolean

optional

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

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

contains

object

optional

Returns objects where the specified array contains a value.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

not

object

optional

Returns objects where the query is not satisfied.

Show child attributes

value

union

phrase

object

optional

Returns objects where the specified field contains the provided value as a substring.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

and

object

optional

Returns objects where every query is satisfied.

Show child attributes

value

list<SearchJsonQuery>

optional

Show child attributes

SearchJsonQuery

union

isNull

object

optional

Returns objects based on the existence of the specified field.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

boolean

gte

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

anyTerm

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

fuzzy

boolean

optional

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

lte

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

isNull

object

optional

Returns objects based on the existence of the specified field.

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

boolean

gte

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

anyTerm

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

string

fuzzy

boolean

optional

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

lte

object

optional

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

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

value

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

orderBy

object

optional

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

Show child attributes

fields

list<SearchOrdering>

optional

Show child attributes

SearchOrdering

object

Show child attributes

field

string

A reference to an Ontology object property with the form properties.{propertyApiName}.

direction

string

optional

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

pageSize

integer

optional

The page size to use for the endpoint.

pageToken

string

optional

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

fields

list<PropertyApiName>

optional

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

Show child attributes

PropertyApiName

string

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

Response body

SearchObjectsResponse

object

Success response.

Hide child attributes

data

list<OntologyObject>

optional

Show child attributes

OntologyObject

object

Represents an object in the Ontology.

Show child attributes

properties

map<PropertyApiName, PropertyValue>

optional

A map of the property values of the object.

Show child attributes

PropertyApiName

string

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

PropertyValue

any

Represents the value of a property in the following format.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	JSON encoded `AttachmentProperty` object	`{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}`
Boolean	boolean	`true`
Byte	number	`31`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Float	number	`3.14159265`
GeoPoint	geojson	`{"type":"Point","coordinates":[102.0,0.5]}`
GeoShape	geojson	`{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}`
Integer	number	`238940`
Long	string	`"58319870951433"`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.

rid

string

The unique resource identifier of an object, useful for interacting with other Foundry APIs.

nextPageToken

string

optional

totalCount

string

The total number of items across all pages.

Examples

Request

Copied!

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/objects/employee/search" \
	-d '{"query":{"not":{"field":"properties.age","eq":21}}}'

Response

Copied!

{
  "data": [
    {
      "properties": {
        "lastName": "smith",
        "firstName": "john",
        "age": 21
      },
      "rid": "ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb"
    }
  ]
}