인터페이스 유형 목록(List Interface Types) (V2)

온톨로지에 정의된 인터페이스 유형을 페이지 단위로 조회합니다. 이 API는 미리보기 기능이며 변경되거나 제거될 수 있습니다. 호출할 때 preview=true를 지정합니다.

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

HTTP 요청

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

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

경로 매개변수

쿼리 매개변수

요청 본문

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

응답

응답 형식은 ListInterfaceTypesResponse입니다.

성공 응답입니다.

data의 구조

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

온톨로지 인터페이스 유형의 정의입니다.

전체 필드는 인터페이스 메타데이터를 따릅니다.

인터페이스 유형 목록의 응답 예시입니다.

{
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z",
  "data": [
    {
      "apiName": "Athlete",
      "displayName": "Athlete",
      "description": "Good at sportsball",
      "properties": {
        "name": {
          "rid": "com.palantir.property.d1abdbfe-0ce2-4fff-b0af-af21002c314b",
          "apiName": "name",
          "displayName": "Name",
          "dataType": {
            "type": "string"
          },
          "required": true
        }
      },
      "extendsInterfaces": [
        "Human"
      ],
      "rid": "ri.ontology.main.interface.bea1af8c-7d5c-4ec9-b845-8eeed6d77482"
    }
  ]
}

개별 오류

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

요청 예제

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

브랜치 예시 값은 실제 조회할 Foundry 브랜치로 바꿉니다. 기본 브랜치를 조회하려면 branch 쿼리 매개변수를 생략합니다.

cURL

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

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/interfaceTypes?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&preview=true'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ListInterfaceTypesExample.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 ListInterfaceTypesExample {
    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/interfaceTypes?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&preview=true");
            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/interfaceTypes?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&preview=true`, {
    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/interfaceTypes?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&preview=true" `
	-Headers $headers

$response.content