Search documentation
karat

+

K

User Documentation ↗

Get Query Type

GET/api/v2/ontologies/{ontology}/queryTypes/{queryApiName}

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.

Path parameters

ontology
string

The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.

queryApiName
string

The API name of the query type. To find the API name, use the List query types endpoint or check the Ontology Manager.

Response body

QueryTypeV2
object

Success response.

Hide child attributes

Hide child attributes

apiName
string

The name of the Query in the API.

description
string
optional
displayName
string
optional

The display name of the entity.

parameters
map<ParameterId, QueryParameterV2>
optional
Show child attributes

Show child attributes

output
union

A union of all the types supported by Ontology Query parameters or outputs.

Show child attributes

Show child attributes

rid
string

The unique resource identifier of a Function, useful for interacting with other Foundry APIs.

version
string

The version of the given Function, written <major>.<minor>.<patch>-<tag>, where -<tag> is optional. Examples: 1.2.3, 1.2.3-rc1.

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/ontologies/palantir/queryTypes/getEmployeesInCity"

Response

Copied!
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" }