This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Search for objects in the specified federated source. The request body is used to filter objects based on the specified query. The supported queries depend on what is supported by the federated source. Returns the full object.
stringThe name of the federated source to search in.
stringThe namespace of the federated source to search in.
booleanRepresents a boolean value that restricts an endpoint to preview mode when set to true.
objectSearch request to issue against a federated federated source for finding and returning objects.
query is required, and represents the query to execute when searching for objects. The exact types of queries
allowed depends on the federated source.
pageSize and pageToken are optional and are used for pagination of large result sets;
see the Paging instructions for more information.
If not specified, pageSize defaults to a page size of 100 results; 100 is also the maximum allowed page size.
Specifying an invalid page size results in an InvalidPageSize general error.
unionintegerThe 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 populate the next request's pageToken field with it.
objectA list of the objects that match the search query.
list<GothamOntologyObject>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 populate the next request's pageToken field with it.
1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/gotham/v1/federatedSources/My Federated Source/namespaces/My Federated Source namespace/objects/search?preview=true" \
-d '{"query":{"type":"and","value":[{"type":"term","field":"com.palantir.property.name:FIRST_NAME","value":"John"},{"type":"term","field":"com.palantir.property.age","value":24}]}}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"data": [
{
"primaryKey": "ri.gotham.111111-0.object-internal.111111",
"objectType": "com.palantir.object.person",
"properties": {
"com.palantir.property.name": [
{
"FIRST_NAME": "John",
"LAST_NAME": "Smith"
}
],
"com.palantir.property.age": [
37
]
}
}
]
}