Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

액션의 검증 응답

단일 액션의 validation은 전체 결과, 제출 조건과 각 매개변수의 평가 결과를 담습니다. VALID와 INVALID를 확인하고, 실패한 입력이나 제출 조건에 맞춰 요청을 수정합니다. VALIDATE_ONLY로 요청한 경우 검증 결과가 유효해도 액션을 실행하지 않습니다.

이름자료형필수 여부의미와 조건예시 값
resultenum필수검증 상태입니다. 허용값: VALID, INVALID.
submissionCriterialist<SubmissionCriteriaEvaluation>선택
parametersmap<ParameterId, ParameterEvaluationResult>선택

submissionCriteria의 구조

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

액션 적용의 사전 조건인 제출 조건의 평가 결과입니다. 제출 조건은 Ontology Manager에서 구성합니다.

이름자료형필수 여부의미와 조건예시 값
configuredFailureMessagestring선택충족하지 못한 제출 조건에 구성된 실패 메시지입니다.
resultenum필수검증 상태입니다. 허용값: VALID, INVALID.

parameters의 구조

맵의 키는 ParameterId(string), 값은 ParameterEvaluationResult(object)입니다.

키: 액션이나 쿼리 입력에 사용하는 매개변수의 고유 ID입니다. 매개변수는 Ontology Manager에서 확인하고 관리할 수 있습니다.

구성된 제약에 대한 매개변수의 검증 결과입니다.

이름자료형필수 여부의미와 조건예시 값
resultenum필수검증 상태입니다. 허용값: VALID, INVALID.
evaluatedConstraintslist<ParameterEvaluatedConstraint>선택
requiredboolean필수액션에 필수 입력인지 나타냅니다.
defaultValueany선택중첩 가능한 데이터 값입니다. 자료형별 JSON 표현은 액션 데이터 값을 따릅니다.
evaluatedConstraints의 구조

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

Ontology Manager에서 구성한 매개변수 제약의 평가 결과입니다. 적용할 제약은 입력에 따라 동적으로 결정되며, 최종 제약 집합을 기준으로 값을 평가합니다.

평가된 제약의 11개 분기 중 하나입니다.

평가된 제약

입력에 따라 적용할 제약을 동적으로 정한 뒤 최종 제약 집합으로 값을 평가합니다. unevaluable이면 그 매개변수가 의존하는 다른 매개변수나 객체 집합의 평가 결과를 확인합니다.

분기 struct

단일 구조체 매개변수의 검증 결과입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: struct.struct
structFieldsmap<StructParameterFieldApiName, StructFieldEvaluationResult>선택
structFields의 구조

맵의 키는 StructParameterFieldApiName(string), 값은 StructFieldEvaluationResult(object)입니다.

키: 구조체 매개변수 필드의 고유 식별자입니다.

구조체 필드에 구성된 제약의 평가 결과입니다.

구조체 필드의 평가를 따릅니다.

분기 oneOf

매개변수에 미리 정의한 선택지가 있습니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: oneOf.oneOf
optionslist<ParameterOption>선택
otherValuesAllowedboolean필수사용자가 직접 입력한 값을 허용할지 나타냅니다. Ontology Manager의 Allowed "Other" value 설정에 대응합니다.
options의 구조

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

액션 관리자가 Ontology Manager에서 정의한 선택지입니다.

이름자료형필수 여부의미와 조건예시 값
displayNamestring선택표시 이름입니다.
valueany선택액션 매개변수에 구성된 허용값입니다.

분기 array

항목별 평가를 지원하는 배열 매개변수의 제약 평가 결과입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: array.array
entrieslist<ArrayEntryEvaluatedConstraint>선택
entries의 구조

배열 항목은 ArrayEntryEvaluatedConstraint이며 자료형은 union<struct>입니다.

배열의 각 항목에 대한 제약 평가 결과입니다. 항목별 평가를 지원하는 매개변수에 적용됩니다.

분기 struct

단일 구조체 매개변수의 검증 결과입니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: struct.struct
structFieldsmap<StructParameterFieldApiName, StructFieldEvaluationResult>선택
structFields의 구조

맵의 키는 StructParameterFieldApiName(string), 값은 StructFieldEvaluationResult(object)입니다.

키: 구조체 매개변수 필드의 고유 식별자입니다.

구조체 필드에 구성된 제약의 평가 결과입니다.

구조체 필드의 평가를 따릅니다.

분기 groupMember

제약에 지정된 그룹 중 적어도 하나에 속하는 사용자 ID여야 합니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: groupMember.groupMember

분기 objectPropertyValue

객체 집합에서 찾은 객체의 속성값이어야 합니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: objectPropertyValue.objectPropertyValue

분기 range

매개변수 값이 지정한 범위를 충족해야 합니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: range.range
ltany선택해당 값 미만입니다.
lteany선택해당 값 이하입니다.
gtany선택해당 값 초과입니다.
gteany선택해당 값 이상입니다.

분기 arraySize

배열의 항목 수가 지정한 범위를 충족해야 합니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: arraySize.arraySize
ltany선택해당 값 미만입니다.
lteany선택해당 값 이하입니다.
gtany선택해당 값 초과입니다.
gteany선택해당 값 이상입니다.

분기 objectQueryResult

객체 집합에서 찾은 객체의 기본 키여야 합니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: objectQueryResult.objectQueryResult

분기 stringLength

문자열의 길이 범위 제약입니다. 허용 길이의 경계는 액션 검증 결과에서 확인합니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: stringLength.stringLength
ltany선택문자열 길이의 상한을 나타내는 필드입니다.
lteany선택문자열 길이의 상한을 나타내는 필드입니다.
gtany선택문자열 길이의 하한을 나타내는 필드입니다.
gteany선택문자열 길이의 하한을 나타내는 필드입니다.

분기 stringRegexMatch

미리 정의한 정규식에 맞아야 합니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: stringRegexMatch.stringRegexMatch
regexstring필수Ontology Manager에서 구성한 정규식입니다.
configuredFailureMessagestring선택정규식에 맞지 않을 때 사용할 실패 메시지입니다. Ontology Manager에서 매개변수별로 구성합니다.

분기 unevaluable

의존하는 다른 매개변수나 객체 집합을 평가할 수 없어 이 매개변수도 평가할 수 없습니다. 예를 들어 허용값을 정하는 다른 매개변수가 없거나 유효하지 않을 때 발생합니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: unevaluable.unevaluable

구조체 필드의 평가

structFields의 키는 구조체 필드 API 이름입니다. 각 필드의 결과에는 다음 구조를 사용합니다. 배열의 항목별 평가에서도 같은 구조체 평가를 사용합니다.

이름자료형필수 여부의미와 조건예시 값
resultenum필수검증 상태입니다. 허용값: VALID, INVALID.
evaluatedConstraintslist<StructFieldEvaluatedConstraint>선택
requiredboolean필수액션에 필수 입력인지 나타냅니다.

evaluatedConstraints의 구조

배열 항목은 StructFieldEvaluatedConstraint이며 자료형은 union<oneOf, range, objectQueryResult, stringLength, stringRegexMatch>입니다.

구조체 필드에 구성한 제약의 평가 결과입니다. 적용할 제약은 입력에 따라 동적으로 결정되며, 최종 제약 집합을 기준으로 필드 값을 평가합니다.

분기 oneOf

매개변수에 미리 정의한 선택지가 있습니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: oneOf.oneOf
optionslist<ParameterOption>선택
otherValuesAllowedboolean필수사용자가 직접 입력한 값을 허용할지 나타냅니다. Ontology Manager의 Allowed "Other" value 설정에 대응합니다.
options의 구조

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

액션 관리자가 Ontology Manager에서 정의한 선택지입니다.

이름자료형필수 여부의미와 조건예시 값
displayNamestring선택표시 이름입니다.
valueany선택액션 매개변수에 구성된 허용값입니다.
분기 range

매개변수 값이 지정한 범위를 충족해야 합니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: range.range
ltany선택해당 값 미만입니다.
lteany선택해당 값 이하입니다.
gtany선택해당 값 초과입니다.
gteany선택해당 값 이상입니다.
분기 objectQueryResult

객체 집합에서 찾은 객체의 기본 키여야 합니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: objectQueryResult.objectQueryResult
분기 stringLength

문자열의 길이 범위 제약입니다. 허용 길이의 경계는 액션 검증 결과에서 확인합니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: stringLength.stringLength
ltany선택문자열 길이의 상한을 나타내는 필드입니다.
lteany선택문자열 길이의 상한을 나타내는 필드입니다.
gtany선택문자열 길이의 하한을 나타내는 필드입니다.
gteany선택문자열 길이의 하한을 나타내는 필드입니다.
분기 stringRegexMatch

미리 정의한 정규식에 맞아야 합니다.

이름자료형필수 여부의미와 조건예시 값
typeenum필수허용값: stringRegexMatch.stringRegexMatch
regexstring필수Ontology Manager에서 구성한 정규식입니다.
configuredFailureMessagestring선택정규식에 맞지 않을 때 사용할 실패 메시지입니다. Ontology Manager에서 매개변수별로 구성합니다.

길이 경계와 기본값

stringLength의 허용 길이를 확인할 때는 반환된 lt, lte, gt, gte와 경계 길이에 대한 액션 검증 결과를 함께 확인합니다. 평가 결과의 defaultValue 필드가 있어도 Apply Action은 매개변수 기본값 적용을 지원하지 않으므로 필요한 입력값을 명시합니다.