액션 입력 검증(Validate Action) (V1)
액션을 적용하지 않고 매개변수와 제출 조건을 검증합니다. 응답의 result는 VALID 또는 INVALID이며, 매개변수별 평가와 제출 조건별 평가를 함께 확인할 수 있습니다.
성능을 위해 기존 객체나 다른 Foundry 데이터는 검사하지 않습니다. 따라서 기본 키의 고유성이나 사용자 ID의 존재는 이 검증으로 확인할 수 없습니다. 구성된 매개변수 기본값도 지원하지 않으며, 생략한 매개변수에는 null을 적용합니다.
| 위치 | 이름 | 자료형 | 필수 여부 | 의미 |
|---|---|---|---|---|
| 경로 | ontologyRid | string | 필수 | 액션이 속한 온톨로지 RID |
| 경로 | actionType | string | 필수 | 검증할 액션 유형 API 이름 |
| 본문 | parameters | map<ParameterId, DataValue> | 선택 | 검증할 입력값 |
쿼리 매개변수는 없습니다. ValidateActionRequest JSON 본문은 필수입니다. 온톨로지 RID는 List Ontologies나 Ontology Manager에서, 액션 이름은 List Action Types나 Ontology Manager에서 확인합니다. 입력값은 DataValue 형식을 따릅니다.
검증 응답
ValidateActionResponse의 result는 필수이고, submissionCriteria 목록과 parameters 평가 맵은 선택 항목입니다. 매개변수 결과에는 필수 result와 required, 선택적인 evaluatedConstraints와 defaultValue가 있습니다. 검증 결과와 제약 자료형에서 11가지 제약과 구조체 및 배열 항목의 평가 형식을 확인합니다.
예시는 여러 인적 사항을 입력받도록 구성한 가상 액션의 검증입니다. age: 17은 18세 이상이라는 조건에 맞지 않으며 제출 조건도 INVALID입니다. lastName에는 선택값과 다른 값도 허용하고, numbers에는 2개 이상 4개 이하, percentage에는 0 이상 100 미만이라는 조건이 적용되어 있습니다. configuredFailureMessage는 구성한 메시지이므로 메시지 문구만으로 기존 객체를 조회했다고 해석하지 않습니다.
HTTP 요청
POST /api/v1/ontologies/{ontologyRid}/actions/{actionType}/validate
작업 식별자는 v1.validateAction입니다. Authorization: Bearer <접근 토큰> 헤더로 인증합니다. OAuth 클라이언트에는 api:ontologies-read 권한 범위가 필요합니다.
JSON 요청 예시
가상 액션에 전달하는 요청 예시입니다.
{
"parameters": {
"id": "2",
"firstName": "Chuck",
"lastName": "Jones",
"age": 17,
"date": "2021-05-01",
"numbers": [
1,
2,
3
],
"hasObjectSet": true,
"objectSet": "ri.object-set.main.object-set.39a9f4bd-f77e-45ce-9772-70f25852f623",
"reference": "Chuck",
"percentage": 41.3,
"differentObjectId": "2"
}
}
JSON 응답 예시
가상 온톨로지의 응답 예시입니다.
{
"result": "INVALID",
"submissionCriteria": [
{
"configuredFailureMessage": "First name can not match the first name of the referenced object.",
"result": "INVALID"
}
],
"parameters": {
"age": {
"result": "INVALID",
"evaluatedConstraints": [
{
"type": "range",
"gte": 18
}
],
"required": true
},
"id": {
"result": "VALID",
"evaluatedConstraints": [],
"required": true
},
"date": {
"result": "VALID",
"evaluatedConstraints": [],
"required": true
},
"lastName": {
"result": "VALID",
"evaluatedConstraints": [
{
"type": "oneOf",
"options": [
{
"displayName": "Doe",
"value": "Doe"
},
{
"displayName": "Smith",
"value": "Smith"
},
{
"displayName": "Adams",
"value": "Adams"
},
{
"displayName": "Jones",
"value": "Jones"
}
],
"otherValuesAllowed": true
}
],
"required": true
},
"numbers": {
"result": "VALID",
"evaluatedConstraints": [
{
"type": "arraySize",
"lte": 4,
"gte": 2
}
],
"required": true
},
"differentObjectId": {
"result": "VALID",
"evaluatedConstraints": [
{
"type": "objectPropertyValue"
}
],
"required": false
},
"firstName": {
"result": "VALID",
"evaluatedConstraints": [],
"required": true
},
"reference": {
"result": "VALID",
"evaluatedConstraints": [
{
"type": "objectQueryResult"
}
],
"required": false
},
"percentage": {
"result": "VALID",
"evaluatedConstraints": [
{
"type": "range",
"lt": 100,
"gte": 0
}
],
"required": true
},
"objectSet": {
"result": "VALID",
"evaluatedConstraints": [],
"required": true
},
"attachment": {
"result": "VALID",
"evaluatedConstraints": [],
"required": false
},
"hasObjectSet": {
"result": "VALID",
"evaluatedConstraints": [],
"required": false
},
"multipleAttachments": {
"result": "VALID",
"evaluatedConstraints": [
{
"type": "arraySize",
"gte": 0
}
],
"required": false
}
}
}
오류
실패 응답은 공통 API 오류의 형식으로 처리합니다.
요청 예제
FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 아래 식별자와 입력값은 예시이므로 실제 요청 대상에 맞게 지정합니다.
cURL
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
"https://${FOUNDRY_HOST}/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/actions/rename-employee/validate" \
-d '{"parameters":{"id":"2","firstName":"Chuck","lastName":"Jones","age":17,"date":"2021-05-01","numbers":[1,2,3],"hasObjectSet":true,"objectSet":"ri.object-set.main.object-set.39a9f4bd-f77e-45ce-9772-70f25852f623","reference":"Chuck","percentage":41.3,"differentObjectId":"2"}}'
Python
Requests 라이브러리가 설치된 Python 환경에서 사용합니다.
import os
import requests
HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
"content-type": "application/json",
"authorization": "Bearer {}".format(TOKEN)
}
request_body = {
"parameters": {
"id": "2",
"firstName": "Chuck",
"lastName": "Jones",
"age": 17,
"date": "2021-05-01",
"numbers": [
1,
2,
3
],
"hasObjectSet": True,
"objectSet": "ri.object-set.main.object-set.39a9f4bd-f77e-45ce-9772-70f25852f623",
"reference": "Chuck",
"percentage": 41.3,
"differentObjectId": "2"
}
}
response = requests.post('https://{}/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/actions/rename-employee/validate'.format(HOSTNAME), headers=headers, json=request_body)
print(response)
Java
Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 ValidateActionExample.java 파일에서 사용합니다.
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
public class ValidateActionExample {
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()) {
HttpPost request = new HttpPost("https://" + HOSTNAME + "/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/actions/rename-employee/validate");
request.addHeader("content-type", "application/json");
request.addHeader("authorization", String.format("Bearer %s", TOKEN));
request.setEntity(new StringEntity("{\"parameters\":{\"id\":\"2\",\"firstName\":\"Chuck\",\"lastName\":\"Jones\",\"age\":17,\"date\":\"2021-05-01\",\"numbers\":[1,2,3],\"hasObjectSet\":true,\"objectSet\":\"ri.object-set.main.object-set.39a9f4bd-f77e-45ce-9772-70f25852f623\",\"reference\":\"Chuck\",\"percentage\":41.3,\"differentObjectId\":\"2\"}}", ContentType.APPLICATION_JSON));
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/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/actions/rename-employee/validate`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${TOKEN}`,
},
body: '{"parameters":{"id":"2","firstName":"Chuck","lastName":"Jones","age":17,"date":"2021-05-01","numbers":[1,2,3],"hasObjectSet":true,"objectSet":"ri.object-set.main.object-set.39a9f4bd-f77e-45ce-9772-70f25852f623","reference":"Chuck","percentage":41.3,"differentObjectId":"2"}}'
}).then((response) => {
console.log(response)
});
PowerShell
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST
$headers = @{
"authorization" = "Bearer $TOKEN"
}
$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/actions/rename-employee/validate" `
-Method Post `
-Headers $headers `
-ContentType application/json `
-Body "{`"parameters`":{`"id`":`"2`",`"firstName`":`"Chuck`",`"lastName`":`"Jones`",`"age`":17,`"date`":`"2021-05-01`",`"numbers`":[1,2,3],`"hasObjectSet`":true,`"objectSet`":`"ri.object-set.main.object-set.39a9f4bd-f77e-45ce-9772-70f25852f623`",`"reference`":`"Chuck`",`"percentage`":41.3,`"differentObjectId`":`"2`"}}"
$response.content