Automation Anywhere 설명서 읽기 및 검토

Automation 360

콘텐츠 닫기

콘텐츠

콘텐츠 열기

WLM 대기열 나열

  • 업데이트: 2022/03/31
    • Automation 360 v.x
    • 탐색
    • RPA Workspace
    • API 문서

WLM 대기열 나열

워크로드 관리 대기열 목록 API를 사용하여 지정된 Control Room과 연결된 모든 대기열 목록을 가져옵니다. .

요청

POST http://{{ControlRoomURL}}/v3/wlm/queues/list
Header: X-Authorization <<authentication token>>
인증 API를 이용하여 JSON 웹 토큰을 생성합니다. 인증 API를 참고하십시오.
필터가 없는 요청 본문:
{
   "sort":[
      {
         "field":"name",
         "direction":"asc"
      }
   ],
   "filter":{
      
   },
   "fields":[
      
   ],
   "page":{
      "offset":0,
      "total":100,
      "totalFilter":100,
      "length":200
   }
}
필터가 있는 요청 본문:
{
"sort": [
  {
   "field": "name",//set sort by criteria
   "direction": "asc"
  }
],
 "filter": {
    "operator": "and",
    "operands": [
      {
        "operator": "eq",
        "value": "DRAFT",
        "field": "status"
      },
      {
        "operator": "substring",
        "value": "Test",
        "field": "name"
      }
    ]
  },
"fields": [],
"page": {//return a limited number of results with offset for pagination
  "offset": 0,
  "total": 100,
  "totalFilter": 100,
  "length": 200
}
}

요청 매개변수

매개변수 유형 필수 사항 설명
분류 Array 아니요 기본적으로 ID별 내림차순으로 검색 결과에 정렬됩니다. 대체 정렬 방식은 정렬 쿼리 매개변수를 사용하여 지정됩니다.

asc(오름차순) 또는 desc(내림차순) 방향으로 정렬할 필드를 입력합니다. 정렬에 대한 자세한 내용은 필터링, 페이지 매김 및 정렬 항목을 참조하십시오.

필터 객체 아니요 결과를 필터링합니다. 정렬에 대한 자세한 내용은 필터링, 페이지 매김 및 정렬 항목을 참조하십시오.
필드 Array 아니요 필드를 기반으로 결과를 필터링합니다.
페이지 객체 아니요 페이지 객체를 사용하면 원하는 페이지에 도달할 수 있습니다. 페이지 매김 규칙에 대한 자세한 내용은 필터링, 페이지 매김 및 정렬 항목을 참조하십시오.
위의 샘플 요청에 대한 응답은 이름에 Test가 있고 상태가 NOT_IN_USE인 대기열의 모든 세부 정보를 반환합니다.

응답

{
    "page": {
        "offset": 0,
        "total": 17,
        "totalFilter": 1
    },
    "list": [
        {
            "id": "32",
            "createdBy": "873",
            "createdOn": "2022-03-02T05:51:53.855636Z",
            "updatedBy": "873",
            "updatedOn": "2022-03-02T05:54:18.745722Z",
            "tenantId": "1",
            "version": "1",
            "tenantUuid": "b6e4eb84-f7ef-4dfd-a432-725b71de8142",
            "name": "for-docs-test",
            "description": "",
            "reactivationThreshold": "1",
            "status": "NOT_IN_USE",
            "manualProcessingTime": "0",
            "manualProcessingTimeUnit": "SECONDS",
            "workItemProcessingOrders": [],
            "workItemModelId": "28",
            "displayColumnIds": [
                "156",
                "157",
                "158",
                "159",
                "160"
            ],
            "considerReactivationThreshold": false
        }
    ]
}

응답 매개변수

매개변수 유형 설명
오프셋 정수 페이지 매김에 사용되는 시작 목록 오프셋.
정수 총 기록 수.
totalFilter 정수 필터를 적용한 후의 기록 수.
목록 Array 대기열의 목록 배열.
역할 객체 나열
id 정수 특정 대기열의 고유 ID.
createdBy 정수 역할을 만든 사용자의 ID입니다.
createdOn 문자열 역할의 생성 타임스탬프입니다.
updatedBy 정수 역할에 대한 최신 업데이트를 수행한 사용자의 ID입니다.
updatedOn 문자열 역할의 최신 업데이트 타임스탬프입니다.
tenantId 정수 테넌트의 ID입니다.
버전 정수 역할 인스턴스의 버전입니다.
tenantUuid 문자열 테넌트의 고유 ID입니다.
이름 문자열 대기열의 이름입니다.
설명 문자열 대기열에 대한 설명입니다.
reactivationThreshold 정수 대기열을 다시 활성화하기 위한 대기열 내 최소 작업 항목 수입니다.
status 문자열 대기열의 현재 상태입니다. 값은 DRAFT, IN_USE 또는 NOT_IN_USE일 수 있습니다.
manualProcessingTime 정수 대기열을 수동으로 처리하는 데 필요한 노력입니다.
manualProcessingTimeUnit 문자열 수동 처리 시간의 단위입니다. 값은 SECONDS, MINUTES, HOURS 또는 DAYS일 수 있습니다.
workItemProcessingOrders Array 작업 항목 처리 순서의 배열입니다.
workItemModelId 정수 작업 항목 모델의 ID입니다.
displayColumnIds Array 열 ID 목록을 표시하는 배열입니다.
considerReactivationThreshold 부울 재활성화 임계값이 필요한지 여부를 나타내는 플래그입니다.
주: Community Edition에서 Control Room APIs을 볼 수 있지만, API 기능은 제한됩니다. API의 전체 기능에 액세스하려면 라이선스가 인가된 Automation 360 에디션이 필요합니다.
REST API는 HTTP 응답 코드를 이용하여 각 요청에 응답합니다. 응답 코드는 API 응답 코드를 참고하십시오.
피드백을 보내주십시오