API 태스크 온디맨드 엔드포인트

엔드포인트로 API 태스크를 즉시 호출하십시오. 그러면 온디맨드 요청과 함께 배포 API를 사용하여 API 태스크가 동적으로 시작되고 실행됩니다. 이 접근 방식은 기존의 정적 배포에 비해 워크플로를 간소화하고 리소스 효율성을 개선합니다.

핵심 이점

  • 프로그래밍 방식 배포: 원하는 API 클라이언트를 사용하여 온디맨드 방식으로 어디서나 API 태스크를 배포하십시오.
  • 프로세싱:
    • 자동화는 필요할 때만 활성화되어 최적의 리소스 활용도를 보장합니다. 즉, 클라우드에 지속적으로 배포되어 리소스를 예약하지 않습니다. 대신 각 요청이 있을 때마다 로드되고 실행됩니다.
    • 사용량이 많은 기간에는 자동화가 대기열에 배치되어 기기를 사용할 수 있게 되는 즉시 실행되므로 부하가 많은 상황에서도 원활한 운영을 보장합니다. 활동 페이지에서 자동화의 진행 상황을 확인할 수 있습니다.
    • 프리미엄 라이선스는 자동화를 확장하고 API 태스크의 여러 인스턴스를 실행할 수 있는 더 큰 클라우드 리소스 풀에 액세스하여 동시성을 높이고 더 많은 API 태스크 요청을 동시에 처리할 수 있도록 도와줍니다.
  • 이상적인 사용 사례:
    • 일괄 처리 작업(예: 판매 데이터 분석, 보고서 생성)
    • 예약된 태스크
    • 즉각적인 대응이 중요하지 않은 상황

인증

배포 API와 상호 작용하는 데 필요한 인증 자격증명을 획득합니다. 여기에는 일반적으로 액세스 토큰 또는 API 키가 포함됩니다. 다음 샘플은 클라우드 장치에 API 태스크 온디맨드를 배포하는 예제입니다. 또한 배포할 때 봇에 변수를 전달할 수도 있습니다.

POST https://{{ControlRoomURL}}/v4/automations/deploy

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<b
earer token>>

모든 API 호출에는 인증 API의 인증 토큰(JSON 웹 토큰 생성) 또는 OAuth 서비스의 전달자 토큰이 포함되어야 합니다. 하나의 API에서 둘 모두를 사용할 수 없습니다.

온디맨드 요청 작성

요청:
{
  "botId": 121,
  "automationName": "SAMPLE_APITASK",
  "description": "My first API Task deploy using api",
  "botLabel": "string",
  "executionType": "RUN_NOW",
  "automationPriority": "PRIORITY_MEDIUM",
  "headlessRequest": {
    "numberOfExecutions": 1,
    "queueOnSlotsExhaustion": false,
    "sharedRunAsUserId": 12
  },
  "botInput": {
    "inputVar": {
      "type": "STRING",
      "string": "PassingString"
    }
  }
}
주:

자동화 배포 요청은 입력 필드 없이 만들 수 있습니다. 입력을 지정하는 경우 API 태스크에서 이러한 매핑된 값을 성공적으로 수신하고, 해당 자동화에 해당하는 변수를 입력으로 표시해야 합니다. 또한 API 태스크의 변수 이름은 요청 본문에 매핑되는 값과 일치해야 합니다.

요청 매개변수
매개변수 유형 필수 설명
botId 정수 예

배포할 자동화의 ID.
automationName 문자열 아니요 배포할 자동화의 이름. 자동화를 쉽게 식별할 수 있도록 이름을 입력할 수 있습니다. 예시: SAMPLE_APITASK, FIRST_API_TASK, apitask-on-demand.
설명 문자열 아니요 배포할 자동화의 설명. 예시: My first API Task deploy using api
botLabel 문자열 아니요 배포할 자동화의 라벨.
executionType 문자열 아니요 봇과 연결된 실행 유형입니다.
automationPriority 문자열 아니요 자동화 우선순위. 기본적으로 PRIORITY_MEDIUM으로 설정됩니다. 자동화 우선순위에 사용할 수 있는 값은 다음과 같습니다. PRIORITY_MEDIUM, PRIORITY_HIGH 및 PRIORITY_LOW.
headlessRequest 객체.
numberOfExecutions 정수 아니요 주어진 온디맨드(헤드리스) 요청에 대해 실행할 실행 횟수입니다.
queueOnSlotsExhaustion 부울 아니요 배포를 대기열에 넣어야 하는지 여부를 지정합니다.
sharedRunAsUserId 정수 아니요 API 태스크에 대한 RunAsUser 컨텍스트를 설정하는 apitaskrunner입니다. apitaskrunner에 대한 자세한 내용은 API 작업의 사용자로 실행(apitaskrunner) 항목을 참조하십시오.
주: 이 RunAsUser에는 Bot Runner 라이선스가 필요하지 않습니다.
botInput 객체
유형 모두 아니요 기본값은 STRING입니다. 유형에 대해 가능한 값은 다음과 같습니다. STRING, NUMBER, BOOLEAN, FILE, ITERATOR, LIST, DICTIONARY, TABLE, VARIABLE, CONDITIONAL, WINDOW, TASKBOT, DATETIME, UIOBJECT, RECORD, EXCEPTION, CREDENTIAL, COORDINATE, IMAGE, REGION, PROPERTIES, TRIGGER, CONDITIONALGROUP, FORM, FORMELEMENT, HOTKEY, and WORKITEM.
응답
{
  "deploymentId": "320a2149-aa44-41ab-af9b-f9343ae2581b",
  "automationName": "SAMPLE_APITASK"
}
응답 매개변수
매개변수 유형 설명
deploymentId 문자열 배포 ID가 생성되었습니다.
automationName 문자열 배포된 자동화의 이름입니다. 요청에 이 이름이 제공되지 않으면 배포된 자동화에 임의의 이름이 지정됩니다.
모든 Control Room 인스턴스에 포함된 Swagger 인터페이스에서 이 엔드포인트를 테스트할 수 있습니다.
팁: Control Room 인스턴스로 이동한 후 URL 끝에 /swagger/를 추가하여 Swagger에 액세스합니다.
https://{{ControlRoomURL}}/swagger/

Control Room에서 활동 페이지를 확인하여 대기 중 >> 진행 중 완료에서 온디맨드(헤드리스) 실행 진행 상황을 추적할 수 있습니다.

API-태스크-활동 페이지

배포 API에 대한 자세한 내용은 Bot 배포 API(V4) 항목을 참조하십시오.