Get Query Type

GET/api/v1/ontologies/{ontologyRid}/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

ontologyRid

string

The 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.

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

QueryType

object

Success response.

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, Parameter>

optional

Show child attributes

output

union

optional

A union of all the primitive types used by Palantir's Ontology-based products.

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!

curl \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/queryTypes/getEmployeesInCity"

Response

Copied!

{
  "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"
}