An Object is a data container for a specific instance of an Object Type. For instance, the com.palantir.object.employee
object type may contain data about several employees, and each one is represented as a single Object.
The search objects endpoint allows searching by properties and other attributes of objects of a given type. The search query is provided as a JSON request body.
Query type | Description |
---|---|
empty | Apply no filter (i.e., list all objects of type objectType). |
eq | The provided property is exactly equal to the provided value. |
and | All the sub-queries match. |
or | At least one of the sub-queries matches. |
keyword | The objects' contents match the specified keyword query. |
lt | The provided property is less than the provided value. |
gt | The provided property is greater than the provided value. |
lte | The provided property is less than or equal to the provided value. |
gte | The provided property is greater than or equal to the provided value. |
not | The sub-query does not match. |
geoPointWithin | Filter objects whose intrinsic coordinates are within the provided polygon |
eq
)Description
The provided property is exactly equal to the provided value.
Example
Copied!1{ 2 "query": { 3 "type": "eq", 4 "field": "com.palantir.property.name:FIRST_NAME", 5 "value": "John" 6 } 7}
Case-sensitive: yes
and
)Description
All the sub-queries match.
Example
Copied!1{ 2 "query": { 3 "type": "and", 4 "value": [ 5 { 6 "type": "eq", 7 "field": "com.palantir.property.name:FIRST_NAME", 8 "value": "John" 9 }, 10 { 11 "type": "eq", 12 "field": "com.palantir.property.name:LAST_NAME", 13 "value": "Smith" 14 } 15 ] 16 } 17}
or
)Description
At least one of the sub-queries matches.
Example
Copied!1{ 2 "query": { 3 "type": "or", 4 "value": [ 5 { 6 "type": "eq", 7 "field": "com.palantir.property.name:FIRST_NAME", 8 "value": "John" 9 }, 10 { 11 "type": "eq", 12 "field": "com.palantir.property.name:FIRST_NAME", 13 "value": "Jane" 14 } 15 ] 16 } 17}
keyword
)Description
The objects' contents match the specified keyword query. Keyword queries support flexible, advanced syntax.
Example
Copied!1{ 2 "query": { 3 "type": "keyword", 4 "query": "quick brown fox" 5 } 6}
empty
)Description
A query that matches all objects for the specified object type.
Example
Copied!1{ 2 "query": { 3 "type": "empty" 4 } 5}
lt
)Description
The provided property is less than the provided value.
Example
Copied!1{ 2 "query": { 3 "type": "lt", 4 "field": "com.palantir.property.age", 5 "value": 10 6 } 7}
gt
)Description
The provided property is greater than the provided value.
Example
Copied!1{ 2 "query": { 3 "type": "gt", 4 "field": "com.palantir.property.age", 5 "value": 10 6 } 7}
lte
)Description
The provided property is less than or equal to the provided value.
Example
Copied!1{ 2 "query": { 3 "type": "lte", 4 "field": "com.palantir.property.age", 5 "value": 10 6 } 7}
gte
)Description
The provided property is greater than or equal to the provided value.
Example
Copied!1{ 2 "query": { 3 "type": "gte", 4 "field": "com.palantir.property.age", 5 "value": 10 6 } 7}
not
)Description
The sub-query does not match.
Example
Copied!1{ 2 "query": { 3 "type": "not", 4 "value": { 5 "type": "eq", 6 "field": "com.palantir.property.name:FIRST_NAME", 7 "value": "John" 8 } 9 } 10}
geoPointWithin
)Description
The objects' intrinsic coordinates are within the provided polygon.
Example
Copied!1{ 2 "query": { 3 "type": "geoPointWithin", 4 "polygon": [ 5 {"longitude":-77.05974824713265,"latitude":38.903335277742656}, 6 {"longitude":-77.06130631105295,"latitude":38.90278989613124}, 7 {"longitude":-77.0628268311872,"latitude":38.905175909773085}, 8 {"longitude":-77.06011742685993,"latitude":38.905195387105344}, 9 {"longitude":-77.05974824713265,"latitude":38.903335277742656} 10 ] 11 } 12}