메인 콘텐츠로 건너뛰기
Vantage API를 사용하면 특정 트랜잭션에 대해 Document skill 및 Process skill 매개변수를 조회하고 그 값을 변경할 수 있습니다. 트랜잭션에 전달되는 Skill 매개변수는 키-값 string 쌍으로 구성됩니다. Document 및 Process skill 매개변수의 경우, Vantage API를 통해 설정된 값이 Vantage UI에서 설정된 값보다 우선 적용됩니다.

Skill Parameter 값 변경

Vantage API를 통해 Skill Parameter 값을 변경하려면 다음 단계를 수행하십시오.

1단계: 트랜잭션 생성 또는 초기화

빈 트랜잭션을 생성하거나 launch 메서드를 사용하여 트랜잭션을 초기화합니다. 이를 위해 transactions 리소스에 POST 요청을 보냅니다:
POST {your-host}/api/publicapi/v1/transactions
또는
POST {your-host}/api/publicapi/v1/transactions/launch?skillId={skill-id}
요청 본문에서 스킬 Parameter의 새 값을 지정한 후, 다음 명령을 실행합니다.

Windows 예제

curl -X POST "{your-host}/api/publicapi/v1/transactions" ^
-H "Authorization: Bearer {token}" ^
-H "Content-Type: application/json" ^
-d "{\"skillId\":\"123\",\"skillParameters\":[{\"key\":\"New parameter\",\"value\":\"Vendors new\"}]}"

Linux 예제

curl -X POST '{your-host}/api/publicapi/v1/transactions' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{"skillId":"123","skillParameters":[{"key":"New parameter","value":"Vendors new"}]}'
참고: 키-값 형식의 Skill Parameter는 최대 10개까지 정의할 수 있으며, 각 키는 최대 128자, 각 값은 최대 256자까지 입력할 수 있습니다.

Skill Parameter 값 가져오기

Vantage API를 사용하여 Skill Parameter 값을 가져오려면 다음 중 하나를 수행하세요.

옵션 1: Skill Parameter 직접 조회

transactions/{transaction-id}/skillParameters 리소스에 GET 요청을 전송합니다:
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/skillParameters/
응답은 다음과 같습니다:
[
  {
    "key": "New parameter",
    "value": "Vendors"
  }
]

옵션 2: 트랜잭션 파일 다운로드

JSON 형식으로 값을 받으려면 transactions/{transaction-id}/files/{file-id}/download 리소스에 GET 요청을 전송합니다:
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/files/{file-id}/download