Automation Anywhere ドキュメントを読んで確認する

Automation Anywhere Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

キューの Work Items を一覧表示

  • 更新済み: 9/09/2020
    • Automation 360 v.x
    • 最新情報
    • RPA Workspace
    • API ドキュメント

キューの Work Items を一覧表示

ワークロード管理 Work Item リスト APIを使用して、指定した Control Room に関連付けられているキュー内のすべての Work Items のリストを取得します。

前提条件

以下が必要です。

  • キュー コンシューマー権限
  • Control Room で登録されたユーザーの認証トークン

    認証 API

  • エンドポイント URL: <your_control_room_url>/v3/wlm/queues/{queueId}/workitems/list

利用できるすべての Work Items の情報をリクエストするには、リクエスト本文を空白にします。リクエスト本文にフィルター パラメーターを追加して、選択可能な WLM Work Items から返される情報を制限します。

サポートされているフィルター可能なパラメーター:
status
キューのステータスの例: 新規、保留、失敗、完了、データエラー、アクティブ、実行準備完了。
  • フィールド: status
  • タイプ: string
{
   "filter": {
    "operator": "eq",
    "value": "ACTIVE",
    "field": "status"
    }  
}
result
Work Item の結果の文字列。Work Item が完了したかスキップされたかなど。
  • フィールド: result
  • タイプ: string
{
  "filter": {
    "operator": "substring",
    "value": "skipped",
    "field": "result"
  }
}
col
カスタム列名に対応する列番号。たとえば、E メール、名、姓などです。
  • フィールド: col
  • タイプ: string
{
  "filter": {
    "operator": "substring",
    "value": "Brian",
    "field": "col1"
  }
}

手順

  1. POST メソッドを使用して認証 JSON Web トークンを生成します。
  2. POST メソッドとエンドポイント URL: <your_control_room_url> {queueId}/v3/wlm/queues//workitems/list を使用します。
    たとえば、Work Items を取得する次の URL で queueId20 と入力します。
    https://192.0.2.0/v3/wlm/queues/20/workitems/list
    リクエスト本文のフィルターを使用して、NEW のステータスで first_name (col1) が Brian となっているすべての Work Items のリストを取得します。

    リクエスト本文:

    {
      "sort": [
        {
          "field": "computedStatus",
          "direction": "asc"
        }
      ],
      "filter": {
        "operator": "and",
        "operands": [
          {
            "operator": "eq",
            "value": "NEW",
            "field": "status"
          },
          {
            "operator": "substring",
            "value": "Brian",
            "field": "col1"
          }
        ]
      },
      "fields": [
        
      ],
      "page": {
        "offset": 0,
        "total": 5,
        "totalFilter": 1,
        "length": 100
      }
    }
  3. リクエストを送信します。
    • REST Client で [送信] をクリックします。
    • Swagger インターフェースで [実行] をクリックします。
    レスポンスは、first_name (col1) が Brian となっていて、ステータスが NEW である Work Item のすべての詳細を返します。
    レスポンス本文:
    {
      "page": {
        "offset": 0,
        "total": 5,
        "totalFilter": 1
      },
      "list": [
        {
          "id": "11804",
          "createdBy": "24",
          "createdOn": "2020-05-26T10:19:34.786711300Z",
          "updatedBy": "24",
          "updatedOn": "2020-05-26T10:19:34.786711300Z",
          "version": "1",
          "json": {
            "id": "1",
            "first_name": "Brian",
            "last_name": "Matthews",
            "email": "bmatthews0@example.com",
            "gender": "Male",
            "Address": "5773 Meadow Ridge Street",
            "Current Balance": "822034.72",
            "Current Card Type": "jcb",
            "Average Bank Balance": "$1,25,365.58 ",
            "Account Number": "1651249",
            "Amount Requested": "12750",
            "Recommended": "6375",
            "Phone": "8607826062"
          },
          "result": "",
          "deviceId": "0",
          "status": "NEW",
          "col1": "Brian",
          "col2": "Matthews",
          "col3": "bmatthews0@example.com",
          "col4": "",
          "col5": "",
          "deviceUserId": "0",
          "queueId": "20",
          "comment": "",
          "automationId": "0",
          "totalPausedTime": "0",
          "error": "",
          "col6": "",
          "col7": "",
          "col8": "",
          "col9": "",
          "col10": ""
        }
      ]
    }
フィードバックを送る