액션 매개변수의 검증 메타데이터

매개변수 정의의 validation.defaultValidation에는 허용값과 배열 크기의 기본 제약이 들어 있습니다. 실제 액션 입력의 검증 결과는 액션 검증 응답에서 확인합니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`defaultValidation`	`object`	필수	매개변수의 검증 제약입니다.

`defaultValidation`의 구조

이름	자료형	필수 여부	의미와 조건	예시 값
`allowedValues`	`union<oneOf, datetime, attachment, valueType, markdown, range, mustBeEmpty, text>`	선택	액션 매개변수에 구성된 허용값 제약입니다.
`arraySize`	`object`	선택	배열 매개변수의 항목 수 범위입니다.

`allowedValues`의 구조

분기 `oneOf`

레이블이 지정된 고정 선택지를 정의합니다. otherValuesAllowed가 false이면 매개변수 값은 이 선택지 중 하나여야 하며, true이면 목록에 없는 값도 허용합니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`type`	`enum`	필수	허용값: `oneOf`.	`oneOf`
`options`	`list<ParameterAllowedValueOption>`	선택	미리 정의한 선택지 목록입니다.
`otherValuesAllowed`	`boolean`	필수	options에 없는 값을 허용할지 지정합니다.

`options`의 구조

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

매개변수에 사용할 수 있는 값입니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`displayName`	`string`	필수	표시 이름입니다.
`value`	`any`	필수	중첩 가능한 데이터 값입니다. 자료형별 JSON 표현은 액션 데이터 값을 따릅니다.

분기 `datetime`

매개변수 값에 적용할 날짜 또는 타임스탬프 범위입니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`type`	`enum`	필수	허용값: `datetime`.	`datetime`
`gt`	`DateTimeBound`	선택	날짜와 시각의 경계값입니다.
`gte`	`DateTimeBound`	선택	날짜와 시각의 경계값입니다.
`lt`	`DateTimeBound`	선택	날짜와 시각의 경계값입니다.
`lte`	`DateTimeBound`	선택	날짜와 시각의 경계값입니다.

`gt`의 구조

날짜 경계값을 따릅니다.

`gte`의 구조

날짜 경계값을 따릅니다.

`lt`의 구조

날짜 경계값을 따릅니다.

`lte`의 구조

날짜 경계값을 따릅니다.

분기 `attachment`

첨부파일 RID가 가리키는 파일이 구성된 크기 제한을 충족해야 합니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`type`	`enum`	필수	허용값: `attachment`.	`attachment`
`maxSizeBytes`	`long`	선택	첨부파일에 허용할 최대 바이트 크기입니다.	`72526847`

분기 `valueType`

참조한 값 유형의 조건을 충족해야 합니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`type`	`enum`	필수	허용값: `valueType`.	`valueType`
`apiName`	`string`	필수	camelCase 형식의 값 유형 API 이름입니다.
`rid`	`string`	필수
`versionId`	`string`	필수

분기 `markdown`

Markdown 문자열에 적용할 길이 범위입니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`type`	`enum`	필수	허용값: `markdown`.	`markdown`
`gte`	`integer`	선택	문자 길이의 하한이며 경계값을 포함합니다.
`lte`	`integer`	선택	문자 길이의 상한이며 경계값을 포함합니다.

분기 `range`

매개변수 값에 적용할 숫자 범위입니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`type`	`enum`	필수	허용값: `range`.	`range`
`gt`	`ConstraintValue`	선택	경계값은 리터럴 또는 다른 매개변수 참조입니다. 참조는 액션을 검증하거나 적용할 때 해석합니다.
`gte`	`ConstraintValue`	선택	경계값은 리터럴 또는 다른 매개변수 참조입니다. 참조는 액션을 검증하거나 적용할 때 해석합니다.
`lt`	`ConstraintValue`	선택	경계값은 리터럴 또는 다른 매개변수 참조입니다. 참조는 액션을 검증하거나 적용할 때 해석합니다.
`lte`	`ConstraintValue`	선택	경계값은 리터럴 또는 다른 매개변수 참조입니다. 참조는 액션을 검증하거나 적용할 때 해석합니다.

분기 `mustBeEmpty`

매개변수를 생략하거나 빈 값으로 제공해야 합니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`type`	`enum`	필수	허용값: `mustBeEmpty`.	`mustBeEmpty`

분기 `text`

문자열의 길이 범위 또는 정규식 조건입니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`type`	`enum`	필수	허용값: `text`.	`text`
`gte`	`integer`	선택	문자 길이의 하한이며 경계값을 포함합니다.
`lte`	`integer`	선택	문자 길이의 상한이며 경계값을 포함합니다.
`regex`	`string`	선택	Elasticsearch 정규식 형식과 지원 문법을 따릅니다.
`configuredFailureMessage`	`string`	선택	패턴에 맞지 않을 때 반환할 메시지입니다.

`arraySize`의 구조

이름	자료형	필수 여부	의미와 조건	예시 값
`gte`	`integer`	선택	해당 값 이상입니다.
`lte`	`integer`	선택	해당 값 이하입니다.

날짜 경계값

각 시간 경계는 현재 평가 시각, 고정 시각 또는 현재로부터의 상대 시각입니다.

분기 `now`

검증을 평가하는 현재 시각입니다. 추가 필드가 없습니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`type`	`enum`	필수	허용값: `now`.	`now`

분기 `fixed`

ISO 8601 타임스탬프 또는 날짜 문자열로 표현한 절대 경계입니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`type`	`enum`	필수	허용값: `fixed`.	`fixed`
`value`	`ConstraintValue`	필수	경계값은 리터럴 또는 다른 매개변수 참조입니다. 참조는 액션을 검증하거나 적용할 때 해석합니다.

`value`의 구조

경계값의 출처를 따릅니다.

분기 `relative`

현재 시각에서 일정 시간만큼 떨어진 시각입니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`type`	`enum`	필수	허용값: `relative`.	`relative`
`duration`	`long`	필수	상대 시각의 이동량입니다.
`unit`	`enum`	필수	상대 시각의 시간 단위입니다. 허용값: `SECOND`, `MINUTE`, `HOUR`, `DAY`, `WEEK`.
`tense`	`enum`	필수	현재를 기준으로 한 상대 시각의 방향입니다. 허용값: `FUTURE`, `PAST`.

경계값의 출처

다른 매개변수를 참조하는 경계는 액션을 검증하거나 적용할 때 해석합니다. 참조 대상이 메타데이터 응답에 없을 수도 있습니다.

분기 `static`

리터럴 제약값입니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`type`	`enum`	필수	허용값: `static`.	`static`
`value`	`any`	필수	중첩 가능한 데이터 값입니다. 자료형별 JSON 표현은 액션 데이터 값을 따릅니다.

분기 `parameterLength`

같은 액션 유형에 속한 다른 목록 매개변수의 항목 수입니다. 참조 대상이 응답에 포함되지 않을 수 있으므로 클라이언트는 해석할 수 없는 참조도 처리해야 합니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`type`	`enum`	필수	허용값: `parameterLength`.	`parameterLength`
`parameterId`	`string`	필수	액션이나 쿼리 입력에 사용하는 매개변수의 고유 ID입니다. 매개변수는 Ontology Manager에서 확인하고 관리할 수 있습니다.

분기 `parameterValue`

같은 액션 유형의 다른 매개변수 값입니다. 참조 대상이 응답에 포함되지 않을 수 있으므로 클라이언트는 해석할 수 없는 참조도 처리해야 합니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`type`	`enum`	필수	허용값: `parameterValue`.	`parameterValue`
`parameterId`	`string`	필수	액션이나 쿼리 입력에 사용하는 매개변수의 고유 ID입니다. 매개변수는 Ontology Manager에서 확인하고 관리할 수 있습니다.

Keyboard shortcuts

팔란티어 플랫폼 한국어 해설