Query.md

Query

Method	HTTP request
execute	POST /v2/ontologies/{ontology}/queries/{queryApiName}/execute

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.

Parameters

Name	Type	Description	Notes
ontology	OntologyIdentifier	ontology
query_api_name	QueryApiName	queryApiName
parameters	Dict[ParameterId, Optional[DataValue]]
artifact_repository	Optional[ArtifactRepositoryRid]	artifactRepository	[optional]
package_name	Optional[SdkPackageName]	packageName	[optional]

Return type

ExecuteQueryResponse

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# OntologyIdentifier | ontology
ontology = "palantir"
# QueryApiName | queryApiName
query_api_name = "getEmployeesInCity"
# Dict[ParameterId, Optional[DataValue]] |
parameters = {"city": "New York"}
# Optional[ArtifactRepositoryRid] | artifactRepository
artifact_repository = None
# Optional[SdkPackageName] | packageName
package_name = None


try:
    api_response = foundry_client.ontologies.Query.execute(
        ontology,
        query_api_name,
        parameters=parameters,
        artifact_repository=artifact_repository,
        package_name=package_name,
    )
    print("The execute response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling Query.execute: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	ExecuteQueryResponse	Success response.	application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]