Execute Query

POST/api/v2/ontologies/{ontology}/queries/{queryApiName}/execute

Executes a Query using the given parameters.

Optional parameters do not need to be supplied.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontologies-read.

Path parameters

ontology

string

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

queryApiName

string

The API name of the Query to execute.

Query parameters

version

string

optional

The version of the Query to execute.

sdkPackageRid

string

optional

The package rid of the generated SDK.

sdkVersion

string

optional

The version of the generated SDK.

Request body

ExecuteQueryRequest

object

Hide child attributes

parameters

map<ParameterId, DataValue>

optional

Show child attributes

Response body

ExecuteQueryResponse

object

Success response.

Hide child attributes

value

any

Represents the value of data in the following format. Note that these values can be nested, for example an array of structs.

Type	JSON encoding	Example
Array	array	`["alpha", "bravo", "charlie"]`
Attachment	string	`"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"`
Boolean	boolean	`true`
Byte	number	`31`
CipherText	string	`"CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER"`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
EntrySet	array of JSON objects	`[{"key": "EMP1234", "value": "true"}, {"key": "EMP4444", "value": "false"}]`
Float	number	`3.14159265`
Integer	number	`238940`
Long	string	`"58319870951433"`
Marking	string	`"MU"`
Null	null	`null`
Object Set	string OR the object set definition	`ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z`
Ontology Object Reference	JSON encoding of the object's primary key	`10033123` or `"EMP1234"`
Ontology Interface Object Reference	JSON encoding of the object's API name and primary key	`{"objectTypeApiName":"Employee", "primaryKeyValue":"EMP1234"}`
Ontology Object Type Reference	string of the object type's api name	`"Employee"`
Set	array	`["alpha", "bravo", "charlie"]`
Short	number	`8739`
String	string	`"Call me Ishmael"`
Struct	JSON object	`{"name": "John Doe", "age": 42}`
TwoDimensionalAggregation	JSON object	`{"groups": [{"key": "alpha", "value": 100}, {"key": "beta", "value": 101}]}`
ThreeDimensionalAggregation	JSON object	`{"groups": [{"key": "NYC", "groups": [{"key": "Engineer", "value" : 100}]}]}`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Examples

Request

Copied!

curl -X POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/ontologies/palantir/queries/getEmployeesInCity/execute" \
	-d '{"parameters":{"city":"New York"}}'

Response

Copied!

{
  "value": [
    "EMP546",
    "EMP609",
    "EMP989"
  ]
}