Gets a specific query type with the given API name.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontologies-read.
stringThe unique Resource Identifier (RID) of the Ontology that contains the query type. To look up your Ontology RID, please use the List ontologies endpoint or check the Ontology Manager.
stringThe API name of the query type. To find the API name, use the List query types endpoint or check the Ontology Manager.
objectSuccess response.
stringThe name of the Query in the API.
stringstringThe display name of the entity.
map<ParameterId, Parameter>stringThe 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.
objectDetails about a parameter of an action or query.
stringstringA 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 |
unionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectlist<OntologyStructField>objectstringThe name of a field in a Struct.
unionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectlist<OntologyStructField>objectstringThe name of a field in a Struct.
unionA union of all the primitive types used by Palantir's Ontology-based products.
booleanobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectobjectobjectobjectobjectobjectobjectobjectobjectstringobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectstringThe 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.
stringThe 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.
objectobjectobjectintegerintegerobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
unionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectstringThe 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.
stringThe 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.
booleanobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectlist<OntologyStructField>objectstringThe name of a field in a Struct.
unionA union of all the primitive types used by Palantir's Ontology-based products.
booleanobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectobjectobjectobjectobjectobjectobjectobjectobjectstringobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectstringThe 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.
stringThe 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.
objectobjectobjectintegerintegerobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
unionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectstringThe 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.
stringThe 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.
objectobjectobjectobjectobjectobjectobjectobjectobjectobjectstringobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectlist<OntologyStructField>objectstringThe name of a field in a Struct.
unionA union of all the primitive types used by Palantir's Ontology-based products.
booleanobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectobjectobjectobjectobjectobjectobjectobjectobjectstringobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectstringThe 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.
stringThe 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.
objectobjectobjectintegerintegerobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
unionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectstringThe 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.
stringThe 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.
objectstringThe 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.
stringThe 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.
objectobjectobjectintegerintegerobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectlist<OntologyStructField>objectstringThe name of a field in a Struct.
unionA union of all the primitive types used by Palantir's Ontology-based products.
booleanobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectobjectobjectobjectobjectobjectobjectobjectobjectstringobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectstringThe 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.
stringThe 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.
objectobjectobjectintegerintegerobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
unionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectstringThe 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.
stringThe 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.
unionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectlist<OntologyStructField>objectstringThe name of a field in a Struct.
unionA union of all the primitive types used by Palantir's Ontology-based products.
booleanobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectobjectobjectobjectobjectobjectobjectobjectobjectstringobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectstringThe 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.
stringThe 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.
objectobjectobjectintegerintegerobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
unionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectstringThe 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.
stringThe 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.
objectobjectstringThe 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.
stringThe 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.
booleanunionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectlist<OntologyStructField>objectstringThe name of a field in a Struct.
unionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectlist<OntologyStructField>objectstringThe name of a field in a Struct.
unionA union of all the primitive types used by Palantir's Ontology-based products.
booleanobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectobjectobjectobjectobjectobjectobjectobjectobjectstringobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectstringThe 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.
stringThe 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.
objectobjectobjectintegerintegerobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
unionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectstringThe 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.
stringThe 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.
booleanobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectlist<OntologyStructField>objectstringThe name of a field in a Struct.
unionA union of all the primitive types used by Palantir's Ontology-based products.
booleanobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectobjectobjectobjectobjectobjectobjectobjectobjectstringobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectstringThe 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.
stringThe 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.
objectobjectobjectintegerintegerobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
unionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectstringThe 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.
stringThe 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.
objectobjectobjectobjectobjectobjectobjectobjectobjectobjectstringobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectlist<OntologyStructField>objectstringThe name of a field in a Struct.
unionA union of all the primitive types used by Palantir's Ontology-based products.
booleanobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectobjectobjectobjectobjectobjectobjectobjectobjectstringobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectstringThe 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.
stringThe 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.
objectobjectobjectintegerintegerobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
unionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectstringThe 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.
stringThe 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.
objectstringThe 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.
stringThe 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.
objectobjectobjectintegerintegerobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectlist<OntologyStructField>objectstringThe name of a field in a Struct.
unionA union of all the primitive types used by Palantir's Ontology-based products.
booleanobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectobjectobjectobjectobjectobjectobjectobjectobjectstringobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectstringThe 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.
stringThe 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.
objectobjectobjectintegerintegerobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
unionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectstringThe 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.
stringThe 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.
unionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectlist<OntologyStructField>objectstringThe name of a field in a Struct.
unionA union of all the primitive types used by Palantir's Ontology-based products.
booleanobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectobjectobjectobjectobjectobjectobjectobjectobjectstringobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
objectstringThe 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.
stringThe 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.
objectobjectobjectintegerintegerobjectunionA union of all the primitive types used by Palantir's Ontology-based products.
unionA union of all the primitive types used by Palantir's Ontology-based products.
objectobjectstringThe 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.
stringThe 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.
objectobjectstringThe 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.
stringThe 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.
stringThe unique resource identifier of a Function, useful for interacting with other Foundry APIs.
stringThe 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/getEmployeesInCity"1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"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"
}