Search documentation
karat

+

K

User Documentation ↗

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 typeDescriptionSupported Types
ltThe provided property is less than the provided value.number, string, date, timestamp
gtThe provided property is greater than the provided value.number, string, date, timestamp
lteThe provided property is less than or equal to the provided value.number, string, date, timestamp
gteThe provided property is greater than or equal to the provided value.number, string, date, timestamp
eqThe provided property is exactly equal to the provided value.number, string, date, timestamp
isNullThe provided property is (or is not) null.all
containsThe provided property contains the provided value.array
notThe sub-query does not match.N/A (applied on a query)
andAll the sub-queries match.N/A (applied on queries)
orAt least one of the sub-queries match.N/A (applied on queries)
prefixThe provided property starts with the provided value.string
phraseThe provided property contains the provided value as a substring.string
anyTermThe provided property contains at least one of the terms separated by whitespace.string
allTermsThe provided property contains all the terms separated by whitespace.string

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 children

Hide children

query
union
Show children

Show children

or
object
optional

Returns objects where at least 1 query is satisfied.

Show children

Show children

value
list<SearchJsonQuery>
optional
Show children

Show children

SearchJsonQuery
union
Show children

Show children

or
object
optional

Returns objects where at least 1 query is satisfied.

Show children

Show children

value
list<SearchJsonQuery>
optional
Show children

Show children

SearchJsonQuery
union
prefix
object
optional

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

Show children

Show children

field
string

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

value
string
lt
object
optional

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

Show children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

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 children

Show children

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.

eq
object
optional

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

Show children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

gt
object
optional

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

Show children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

contains
object
optional

Returns objects where the specified array contains a value.

Show children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

not
object
optional

Returns objects where the query is not satisfied.

Show children

Show children

value
union
phrase
object
optional

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

Show children

Show children

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 children

Show children

value
list<SearchJsonQuery>
optional
Show children

Show children

SearchJsonQuery
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show children

Show children

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 children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

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 children

Show children

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 children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

prefix
object
optional

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

Show children

Show children

field
string

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

value
string
lt
object
optional

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

Show children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

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 children

Show children

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.

eq
object
optional

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

Show children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

gt
object
optional

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

Show children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

contains
object
optional

Returns objects where the specified array contains a value.

Show children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

not
object
optional

Returns objects where the query is not satisfied.

Show children

Show children

value
union
Show children

Show children

or
object
optional

Returns objects where at least 1 query is satisfied.

Show children

Show children

value
list<SearchJsonQuery>
optional
Show children

Show children

SearchJsonQuery
union
prefix
object
optional

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

Show children

Show children

field
string

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

value
string
lt
object
optional

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

Show children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

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 children

Show children

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.

eq
object
optional

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

Show children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

gt
object
optional

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

Show children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

contains
object
optional

Returns objects where the specified array contains a value.

Show children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

not
object
optional

Returns objects where the query is not satisfied.

Show children

Show children

value
union
phrase
object
optional

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

Show children

Show children

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 children

Show children

value
list<SearchJsonQuery>
optional
Show children

Show children

SearchJsonQuery
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show children

Show children

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 children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

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 children

Show children

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 children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

phrase
object
optional

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

Show children

Show children

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 children

Show children

value
list<SearchJsonQuery>
optional
Show children

Show children

SearchJsonQuery
union
Show children

Show children

or
object
optional

Returns objects where at least 1 query is satisfied.

Show children

Show children

value
list<SearchJsonQuery>
optional
Show children

Show children

SearchJsonQuery
union
prefix
object
optional

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

Show children

Show children

field
string

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

value
string
lt
object
optional

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

Show children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

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 children

Show children

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.

eq
object
optional

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

Show children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

gt
object
optional

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

Show children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

contains
object
optional

Returns objects where the specified array contains a value.

Show children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

not
object
optional

Returns objects where the query is not satisfied.

Show children

Show children

value
union
phrase
object
optional

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

Show children

Show children

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 children

Show children

value
list<SearchJsonQuery>
optional
Show children

Show children

SearchJsonQuery
union
isNull
object
optional

Returns objects based on the existence of the specified field.

Show children

Show children

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 children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

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 children

Show children

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 children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

isNull
object
optional

Returns objects based on the existence of the specified field.

Show children

Show children

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 children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

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 children

Show children

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 children

Show children

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.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

orderBy
object
optional

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

Show children

Show children

fields
list<SearchOrdering>
optional
Show children

Show children

SearchOrdering
object
Show children

Show children

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 populate the next request's pageToken field with it.

fields
list<PropertyApiName>
optional

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

Show children

Show children

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 children

Hide children

data
list<OntologyObject>
optional
Show children

Show children

OntologyObject
object

Represents an object in the Ontology.

Show children

Show children

properties
map<PropertyApiName, PropertyValue>
optional

A map of the property values of the object.

Show children

Show children

PropertyApiName
string

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

PropertyValue
any

Represents the value of a property in the following format.

TypeJSON encodingExample
Arrayarray["alpha", "bravo", "charlie"]
AttachmentJSON encoded AttachmentProperty object{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}
Booleanbooleantrue
Bytenumber31
DateISO 8601 extended local date string"2021-05-01"
Decimalstring"2.718281828"
Doublenumber3.14159265
Floatnumber3.14159265
GeoPointgeojson{"type":"Point","coordinates":[102.0,0.5]}
GeoShapegeojson{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}
Integernumber238940
Longstring"58319870951433"
Shortnumber8739
Stringstring"Call me Ishmael"
TimestampISO 8601 extended offset date-time string in UTC zone"2021-01-04T05:00:00Z"

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

rid
string

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

nextPageToken
string
optional

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

totalCount
string

The total number of items across all pages.

Examples

Request

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

Response

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