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
.
string
The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.
string
The API name of the query type. To find the API name, use the List query types endpoint or check the Ontology Manager.
object
Success response.
string
The name of the Query in the API.
string
string
The display name of the entity.
map<ParameterId, QueryParameterV2>
union
A union of all the types supported by Ontology Query parameters or outputs.
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/v2/ontologies/palantir/queryTypes/getEmployeesInCity"
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
{
"apiName": "getEmployeesInCity",
"displayName": "Get Employees in City",
"description": "Gets all employees in a given city",
"parameters": {
"city": {
"dataType": {
"type": "string"
},
"description": "The city to search for employees in",
"required": true
}
},
"output": {
"dataType": {
"type": "array",
"subType": {
"type": "object",
"objectApiName": "Employee"
}
},
"required": true
},
"rid": "ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b",
"version": "1.1.3-rc1"
}