Lists the query types for the given Ontology.
Each page may be smaller than the requested page size. However, it is guaranteed that if there are more results available, at least one result will be present in the response.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontologies-read
.
string
The unique Resource Identifier (RID) of the Ontology that contains the query types. To look up your Ontology RID, please use the List ontologies endpoint or check the Ontology Manager.
integer
The desired size of the page to be returned. Defaults to 100. See page sizes for details.
string
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.
object
Success response.
string
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.
list<QueryType>
object
Represents a query type in the Ontology.
string
The name of the Query in the API.
string
string
The display name of the entity.
map<ParameterId, Parameter>
string
The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied. Parameters can be viewed and managed in the Ontology Manager.
object
Details about a parameter of an action or query.
string
string
A string indicating the type of each data value. Note that these types can be nested, for example an array of structs.
Type | JSON value |
---|---|
Array | Array<T> , where T is the type of the array elements, e.g. Array<String> . |
Attachment | Attachment |
Boolean | Boolean |
Byte | Byte |
Date | LocalDate |
Decimal | Decimal |
Double | Double |
Float | Float |
Integer | Integer |
Long | Long |
Marking | Marking |
OntologyObject | OntologyObject<T> where T is the API name of the referenced object type. |
Short | Short |
String | String |
Struct | Struct<T> where T contains field name and type pairs, e.g. Struct<{ firstName: String, lastName: string }> |
Timeseries | TimeSeries<T> where T is either String for an enum series or Double for a numeric series. |
Timestamp | Timestamp |
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
list<OntologyStructField>
object
string
The name of a field in a Struct
.
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
list<OntologyStructField>
object
string
The name of a field in a Struct
.
union
A union of all the primitive types used by Palantir's Ontology-based products.
boolean
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
object
object
object
object
object
object
object
object
string
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
object
object
integer
integer
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
boolean
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
list<OntologyStructField>
object
string
The name of a field in a Struct
.
union
A union of all the primitive types used by Palantir's Ontology-based products.
boolean
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
object
object
object
object
object
object
object
object
string
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
object
object
integer
integer
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
object
object
object
object
object
object
object
object
object
string
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
list<OntologyStructField>
object
string
The name of a field in a Struct
.
union
A union of all the primitive types used by Palantir's Ontology-based products.
boolean
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
object
object
object
object
object
object
object
object
string
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
object
object
integer
integer
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
object
object
integer
integer
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
list<OntologyStructField>
object
string
The name of a field in a Struct
.
union
A union of all the primitive types used by Palantir's Ontology-based products.
boolean
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
object
object
object
object
object
object
object
object
string
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
object
object
integer
integer
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
list<OntologyStructField>
object
string
The name of a field in a Struct
.
union
A union of all the primitive types used by Palantir's Ontology-based products.
boolean
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
object
object
object
object
object
object
object
object
string
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
object
object
integer
integer
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
boolean
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
list<OntologyStructField>
object
string
The name of a field in a Struct
.
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
list<OntologyStructField>
object
string
The name of a field in a Struct
.
union
A union of all the primitive types used by Palantir's Ontology-based products.
boolean
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
object
object
object
object
object
object
object
object
string
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
object
object
integer
integer
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
boolean
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
list<OntologyStructField>
object
string
The name of a field in a Struct
.
union
A union of all the primitive types used by Palantir's Ontology-based products.
boolean
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
object
object
object
object
object
object
object
object
string
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
object
object
integer
integer
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
object
object
object
object
object
object
object
object
object
string
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
list<OntologyStructField>
object
string
The name of a field in a Struct
.
union
A union of all the primitive types used by Palantir's Ontology-based products.
boolean
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
object
object
object
object
object
object
object
object
string
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
object
object
integer
integer
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
object
object
integer
integer
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
list<OntologyStructField>
object
string
The name of a field in a Struct
.
union
A union of all the primitive types used by Palantir's Ontology-based products.
boolean
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
object
object
object
object
object
object
object
object
string
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
object
object
integer
integer
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
list<OntologyStructField>
object
string
The name of a field in a Struct
.
union
A union of all the primitive types used by Palantir's Ontology-based products.
boolean
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
object
object
object
object
object
object
object
object
string
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
object
object
integer
integer
object
union
A union of all the primitive types used by Palantir's Ontology-based products.
union
A union of all the primitive types used by Palantir's Ontology-based products.
object
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
object
object
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types
endpoint or check the Ontology Manager.
string
The unique resource identifier of a Function, useful for interacting with other Foundry APIs.
string
The version of the given Function, written <major>.<minor>.<patch>-<tag>
, where -<tag>
is optional.
Examples: 1.2.3
, 1.2.3-rc1
.
1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/queryTypes"
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
"nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z",
"data": [
{
"apiName": "getEmployeesInCity",
"displayName": "Get Employees in City",
"description": "Gets all employees in a given city",
"parameters": {
"city": {
"baseType": "String",
"description": "The city to search for employees in",
"required": true
}
},
"output": "Array<OntologyObject<Employee>>",
"rid": "ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b",
"version": "1.1.3-rc1"
},
{
"apiName": "getAverageTenureOfEmployees",
"displayName": "Get Average Tenure",
"description": "Gets the average tenure of all employees",
"parameters": {
"employees": {
"baseType": "String",
"description": "An object set of the employees to calculate the average tenure of",
"required": true
},
"useMedian": {
"baseType": "Boolean",
"description": "An optional flag to use the median instead of the mean, defaults to false",
"required": false
}
},
"output": "Double",
"rid": "ri.function-registry.main.function.9549c29d3-e92f-64a1-beeb-af817819a400",
"version": "2.1.1"
}
]
}