Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

V1 액션 유형 API

액션 유형(ActionType)은 온톨로지에 적용할 변경과 로직의 정의입니다. Ontology Manager에서 구성하며, 실제 액션(Action)은 이 정의를 매개변수와 함께 한 번 적용하는 실행입니다.

작업기능
List Action Types온톨로지의 액션 유형을 페이지 단위로 조회합니다.
Get Action TypeAPI 이름으로 한 액션 유형을 조회합니다.
액션 실행 API단건 및 배치 적용과 매개변수 검증을 수행합니다.

ActionType

필드자료형필수 여부의미
apiNamestring필수액션 유형의 API 이름
descriptionstring선택설명
displayNamestring선택표시 이름
statusenum필수ACTIVE, ENDORSED, EXPERIMENTAL, DEPRECATED
parametersmap<ParameterId, Parameter>선택입력 매개변수 정의
ridstring필수액션 유형 RID
operationslist<LogicRule>선택액션의 변경 규칙 목록

Parameter에는 필수 baseType 문자열과 required 불리언, 선택적인 description 및 구조화된 dataType이 있습니다. 모든 중첩 유형과 값 표현은 매개변수 자료형을 따릅니다.

LogicRule

각 규칙은 type으로 구분합니다. 다음 필드는 해당 변형에서 필수 문자열입니다.

type필드의미
createObjectobjectTypeApiName생성할 객체 유형
modifyObjectobjectTypeApiName수정할 객체 유형
deleteObjectobjectTypeApiName삭제할 객체 유형
createInterfaceObjectinterfaceTypeApiName생성할 인터페이스 유형
modifyInterfaceObjectinterfaceTypeApiName수정할 인터페이스 유형
deleteInterfaceObjectinterfaceTypeApiName삭제할 인터페이스 유형
createLinklinkTypeApiNameAtoB, linkTypeApiNameBtoA, aSideObjectTypeApiName, bSideObjectTypeApiName양방향 링크 API 이름과 A/B 쪽 객체 유형
deleteLinklinkTypeApiNameAtoB, linkTypeApiNameBtoA, aSideObjectTypeApiName, bSideObjectTypeApiName삭제할 링크와 양쪽 객체 유형

인터페이스 API 이름은 UpperCamelCase 형식이며 Ontology Manager 또는 인터페이스 유형 목록에서 확인합니다. 객체와 링크 API 이름도 표시 이름과 구분하여 실제 정의의 값을 사용합니다.

applyScenario 규칙

applyScenario는 참조한 시나리오에 쌓인 편집을 액션이 적용되는 데이터 맥락에 반영합니다. 액션을 기본 온톨로지 맥락에서 적용하면 그 데이터에, 다른 시나리오 맥락에서 적용하면 그 시나리오에 반영합니다.

필드자료형필수 여부의미
scenarioParameterParameterId string필수원본 시나리오를 전달하는 scenarioReference 유형의 매개변수 ID
objectTypeApiNameslist<string>선택영향을 받는 객체 유형 API 이름 목록
linkTypeslist<ObjectTypeLinkTypeApiNameMapping>선택영향을 받는 링크의 범위

ObjectTypeLinkTypeApiNameMapping에는 필수 문자열 objectTypeApiName과 선택적인 linkTypes 문자열 목록이 있습니다. 링크 API 이름은 객체 유형 안에서만 고유하므로 객체 유형과 함께 지정하여 구분합니다.

이 규칙의 메타데이터와 개별 액션 적용 엔드포인트의 입력은 별도 계약입니다. 실제 호출에는 해당 엔드포인트가 제공하는 매개변수만 사용합니다.