API Reference

Execute Query

POST/api/v1/ontologies/{ontologyRid}/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 scopes: api:ontologies-read.

Path parameters

ontologyRid

string

The unique Resource Identifier (RID) of the Ontology that contains the Query. 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 to execute.

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`
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Float	number	`3.14159265`
Double	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"`
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 \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/queries/getEmployeesInCity/execute" \
	-d '{"parameters":{"city":"New York"}}'

Response

Copied!

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