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) |
| containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string |
| containsAllTermsInOrder | The provided property contains the provided term as a substring. | string |
| containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string |
| containsAllTerms | The provided property contains all the terms separated by whitespace. | string |
| startsWith | Deprecated alias for containsAllTermsInOrderPrefixLastTerm. | 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.
stringThe API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.
stringThe API name of the object type. To find the API name, use the List object types endpoint or check the Ontology Manager.
stringThe package rid of the generated SDK.
stringThe version of the generated SDK.
stringThe Foundry branch to search objects from. If not specified, the default branch will be used.
objectunionobjectSpecifies the ordering of search results by a field and an ordering direction or by relevance if scores are required in a nearestNeighbors query. By default orderType is set to fields.
integerThe page size to use for the endpoint.
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.
list<PropertyApiName>The API names of the object type properties to include in the response.
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.
booleanA flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results.
objectSuccess response.
list<OntologyObjectV2>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/objects/employee/search?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252" \
-d '{"where":{"type":"eq","field":"age","value":21}}'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"data": [
{
"__rid": "ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb",
"__primaryKey": 1000,
"__apiName": "Employee",
"employeeId": 1000,
"lastName": "smith",
"firstName": "john",
"age": 21
}
]
}