질의 유형 목록(List Query Types) (V2)

온톨로지의 질의 유형을 각각 최신 버전으로 조회합니다. 최신 버전은 가장 최근에 게시한 버전이며 사전 릴리스 버전일 수도 있습니다.

페이지 크기의 기본값은 100입니다. 반환 페이지는 요청한 크기보다 작을 수 있지만 결과가 더 남아 있으면 적어도 한 항목을 포함합니다. 다음 페이지에는 이전 응답의 nextPageToken을 전달합니다.

HTTP 요청

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

작업 식별자는 v2.listQueryTypesV2입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:ontologies-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

쿼리 매개변수

요청 본문

요청 본문을 사용하지 않습니다.

응답

응답 형식은 ListQueryTypesResponseV2입니다.

성공 응답입니다.

data의 구조

배열 항목은 QueryTypeV2이며 자료형은 QueryTypeV2입니다.

온톨로지 질의 유형의 정의입니다.

전체 필드는 질의 유형 메타데이터를 따릅니다.

질의 유형 목록의 응답 예시입니다.

{
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z",
  "data": [
    {
      "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": {
        "type": "array",
        "subType": {
          "type": "object",
          "objectApiName": "Employee",
          "objectTypeApiName": "Employee"
        }
      },
      "rid": "ri.function-registry.main.function.f0548140-1d67-4120-83b4-e3fed5305a29",
      "version": "1.1.3-rc1"
    },
    {
      "apiName": "getAverageTenureOfEmployees",
      "displayName": "Get Average Tenure",
      "description": "Gets the average tenure of all employees",
      "parameters": {
        "employees": {
          "dataType": {
            "type": "string"
          },
          "description": "The employee object set represented as a string",
          "required": true
        },
        "useMedian": {
          "dataType": {
            "type": "boolean"
          },
          "description": "An optional flag to use the median instead of the mean, defaults to false",
          "required": false
        }
      },
      "output": {
        "type": "double"
      },
      "rid": "ri.function-registry.main.function.9549c29d-e92f-64a1-beeb-af817819a400",
      "version": "2.1.1"
    }
  ]
}

개별 오류

오류 응답 처리는 공통 API 오류 계약을 따릅니다.

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.

온톨로지 API 이름과 브랜치 RID는 실제 대상에 맞춰 바꿉니다. 기본 브랜치를 사용할 때는 branch를 생략합니다.

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/ontologies/palantir/queryTypes?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252"

Python

Requests 라이브러리가 설치된 Python 환경에서 사용합니다.

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "authorization": "Bearer {}".format(TOKEN)
}

response = requests.get('https://{}/api/v2/ontologies/palantir/queryTypes?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ListQueryTypesV2Example.java 파일에서 사용합니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

public class ListQueryTypesV2Example {
    public static void main(String[] args) throws Exception {
        String HOSTNAME = System.getenv("FOUNDRY_HOST");
        String TOKEN = System.getenv("FOUNDRY_TOKEN");

        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
            HttpGet request = new HttpGet("https://" + HOSTNAME + "/api/v2/ontologies/palantir/queryTypes?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                System.out.println(response);
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js 환경에서 사용합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;

fetch(`https://${HOSTNAME}/api/v2/ontologies/palantir/queryTypes?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252`, {
    method: 'GET',
    headers: {
        'Authorization': `Bearer ${TOKEN}`,
    }
}).then((response) => {
    console.log(response)
});

PowerShell

$ErrorActionPreference = 'Stop'
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

$headers = @{
    "authorization" = "Bearer $TOKEN"
}

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/ontologies/palantir/queryTypes?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252" `
	-Headers $headers

$response.content