V1 온톨로지 API
온톨로지(Ontology)는 데이터를 현실의 개념으로 분류합니다. 객체 유형, 속성, 링크 유형과 액션 유형이 조직의 업무 대상을 설명하는 객체 그래프를 구성합니다.
온톨로지 변경은 최종적으로 일관된 상태로 반영됩니다. 새 온톨로지가 API에 나타나기까지 몇 분이 걸릴 수 있으며, 생성 직후에는 OntologyNotFound가 반환될 수 있습니다.
온톨로지와 유형 조회
| 작업 | 기능 |
|---|---|
| List Ontologies | 현재 사용자에게 보이는 온톨로지를 나열합니다. |
| Get Ontology | 온톨로지 RID로 메타데이터를 조회합니다. |
| 객체 유형 API | 객체 유형과 속성 정의, 바깥쪽 링크 유형을 조회합니다. |
| 첨부 파일 API | 액션에 사용할 파일을 업로드하고 메타데이터나 내용을 조회합니다. |
| 액션 유형 API | 액션 유형, 입력 매개변수와 변경 규칙을 조회합니다. |
| 액션 적용과 검증 | 단건 또는 배치로 액션을 적용하고 입력을 검증합니다. |
| 매개변수와 값 자료형 | 액션과 쿼리의 중첩 자료형 및 JSON 값 표현을 확인합니다. |
| 쿼리 유형 API | 쿼리 함수의 입력, 출력과 버전을 조회합니다. |
| 쿼리 실행 | 등록된 쿼리 함수에 매개변수를 전달합니다. |
| 객체 조회, 검색과 집계 | 객체와 연결 관계를 읽고 필터, 검색 및 집계 조건을 적용합니다. |
V1의 ontologyRid에는 온톨로지 RID를 사용합니다. RID는 List Ontologies나 Ontology Manager에서 확인할 수 있습니다.
Ontology 메타데이터
다음 네 필드는 모두 필수 문자열입니다.
| 필드 | 의미 |
|---|---|
apiName | 온톨로지 API 이름 |
displayName | 화면 표시 이름 |
description | 설명 |
rid | 온톨로지를 고유하게 식별하는 RID |
온톨로지를 조회할 수 있는 범위는 실행 사용자의 접근 권한을 따릅니다. API 이름, 표시 이름과 RID를 서로 바꾸어 입력하지 않습니다.