Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

객체 유형 목록(List Object Types) (V2)

온톨로지의 객체 유형 정의를 페이지 단위로 조회합니다. 기본 페이지 크기는 500이며 실제 반환 수는 요청한 크기보다 적거나 많을 수 있습니다. 결과가 더 남아 있으면 응답에 항목이 하나 이상 포함됩니다.

aliases는 이 목록에서 항상 비어 있습니다. 검색 동의어는 RID 기반 조회로 확인합니다. includeDatasources=true이면 사용자가 볼 수 있는 기반 데이터소스를 반환하며 기본값은 false입니다.

HTTP 요청

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

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

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
ontologystring필수온톨로지의 API 이름 또는 RID입니다. List Ontologies 또는 Ontology Manager에서 확인합니다.palantir

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
branchstring선택객체 유형을 조회할 Foundry 브랜치입니다. 생략하면 기본 브랜치를 사용합니다. 브랜치는 실험적 기능이며 모든 작업 경로를 지원하지 않습니다.ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252
pageSizeinteger선택요청할 페이지 크기이며 기본값은 500입니다.
pageTokenstring선택페이지 조회를 시작할 위치입니다. 첫 요청에서는 생략하고, 다음 요청에서는 직전 응답의 nextPageToken을 pageToken으로 전달합니다.
includeDatasourcesboolean선택true이면 각 객체 유형의 datasources에 기반 데이터소스를 채웁니다. 기본값은 false입니다.

요청 본문

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

응답

응답 형식은 ListObjectTypesV2Response입니다.

성공 응답입니다.

이름자료형필수 여부의미와 조건예시 값
nextPageTokenstring선택다음 페이지를 요청할 때 pageToken에 전달할 토큰입니다. 다음 토큰이 없으면 마지막 페이지입니다.
datalist<ObjectTypeV2>선택현재 페이지의 객체 유형 목록입니다.

data의 구조

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

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

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

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

{
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z",
  "data": [
    {
      "apiName": "employee",
      "description": "A full-time or part-time employee of our firm",
      "displayName": "Employee",
      "status": "ACTIVE",
      "primaryKey": "employeeId",
      "properties": {
        "employeeId": {
          "dataType": {
            "type": "integer"
          },
          "rid": "ri.ontology.main.property.571d3d4d-150a-4dd4-b1a7-d16c1ed7d996"
        },
        "fullName": {
          "dataType": {
            "type": "string"
          },
          "rid": "ri.ontology.main.property.5721baa7-26d5-4ca8-b092-d47dcc724ab1"
        },
        "office": {
          "description": "The unique ID of the employee's primary assigned office",
          "dataType": {
            "type": "string"
          },
          "rid": "ri.ontology.main.property.554fa8c4-3b6e-4d3f-adef-acc9f0f54633"
        },
        "startDate": {
          "description": "The date the employee was hired (most recently, if they were re-hired)",
          "dataType": {
            "type": "date"
          },
          "rid": "ri.ontology.main.property.3b081417-fe68-4010-ade8-68b298116ed4"
        }
      },
      "rid": "ri.ontology.main.object-type.0381eda6-69bb-4cb7-8ba0-c6158e094a04",
      "pluralDisplayName": "Employees",
      "icon": {
        "type": "blueprint",
        "name": "globe",
        "color": "#2D72D2"
      },
      "titleProperty": "fullName",
      "aliases": []
    },
    {
      "apiName": "office",
      "description": "A physical location (not including rented co-working spaces)",
      "displayName": "Office",
      "status": "ACTIVE",
      "primaryKey": "officeId",
      "properties": {
        "officeId": {
          "dataType": {
            "type": "string"
          },
          "rid": "ri.ontology.main.property.33d4b7b5-3898-402c-b021-762cffecbe76"
        },
        "address": {
          "description": "The office's physical address (not necessarily shipping address)",
          "dataType": {
            "type": "string"
          },
          "rid": "ri.ontology.main.property.e437ff21-5623-4442-bfd8-b2948416b6ce"
        },
        "capacity": {
          "description": "The maximum seated-at-desk capacity of the office (maximum fire-safe capacity may be higher)",
          "dataType": {
            "type": "integer"
          },
          "rid": "ri.ontology.main.property.87e70a51-c020-48ea-9b65-bfa335ce4778"
        }
      },
      "rid": "ri.ontology.main.object-type.9a0e4409-9b50-499f-a637-a3b8334060d9",
      "pluralDisplayName": "Offices",
      "icon": {
        "type": "blueprint",
        "name": "globe",
        "color": "#2D72D2"
      },
      "titleProperty": "address",
      "aliases": []
    }
  ]
}

개별 오류

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

요청 예제

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

예시 Foundry 브랜치 RID는 실제 조회 맥락에 맞게 바꿉니다. 기본 브랜치를 사용하려면 branch 쿼리를 생략합니다. 브랜치는 실험적 기능입니다.

cURL

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/ontologies/palantir/objectTypes?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/objectTypes?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252'.format(HOSTNAME), headers=headers)
print(response)

Java

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

$response.content