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

Automation Anywhere バージョン11.3

コンテンツを閉じる

コンテンツ

コンテンツを開く

ワークロード管理 API の概要

  • 更新済み: 5/06/2020
    • 11.3.x
    • 最新情報
    • Enterprise
    • 概要

ワークロード管理 API の概要

ワークロード管理 (WLM) API を使用して Control Room をプログラム管理し、キューや作業項目を作成ます。

WLM キュー

WLM キューには、デバイス プール内で Unattended Bot Runner を処理するために分配される作業項目があります。

フィルターを使用することで、レスポンス本文に返された内容を絞り込むことができます。フィルターについての詳細は、「API リクエスト本文でフィルタリング」をご覧ください。

キューを一覧表示
POST http://<your_control_room_url>/v2/wlm/queues/list
本文パラメーター: このリクエスト本文の例には、応答を絞り込むためのフィルタ、ソート、ページ管理などが含まれています。
{
  "filter": {
    "operator": "NONE",
    "operands": [
      null
    ],
    "field": "string",
    "value": "string"
  },
  "sort": [
    {
      "field": "string",
      "direction": "asc"
    }
  ],
  "page": {
    "offset": 0,
    "length": 0
  }
}

すべての WLM キュー リストを返すために POST リクエストを送信するか、リクエスト本文にフィルタリングを使用して応答結果を絞り込みます。リクエスト/応答の例:

フィルターを使用して選択した WLM キューを取り出す

WLM の作業項目

キューで作業項目を作成
POST http://<your_control_room_url>/v2/wlm/queues/{id}/workitems
URL パラメーター:

.../queues/{id}/...: 作業項目を一覧表示させる WLM キューを特定する数値です。

本文パラメーター: 一般的なリクエスト例では、JSON オブジェクトの詳細が特定されません。
{
  "workItems": [
    {
      "json": {}
    }
  ]
}
The following request body example includes a JSON object listing the mandatory key-value pairs that represent a WLM work item.
{
  "workItems": [],
  "json": {
    "Id": "string",
    "Customer Name": "string",
    "Amount": "number",
    "email": "string",
    "Invoice Date": "ISO 8601 date and time notation"
  }
}

JSON オブジェクトには、特定の WLM の実装に必要なキーと値のペアがあります。POST リクエストを送信し、既存のキューに新しい作業項目を追加します。

キューで作業項目を更新
PUT http://<your_control_room_url>/v2/wlm/queues/{id}/workitems/{id}
URL パラメーター:
  • .../queues/{id}/...: 作業項目を一覧表示させる WLM キューを特定する数値です。
  • .../workitems/{id}: キュー内で WLM の作業項目を特定する数値です。
本文パラメーター:
{
  "version": 0,
  "status": "Enum",
  "result": "string",
  "json": {}
}
The following request body example includes a JSON object listing the mandatory key-value pairs that represent a WLM work item.
{
  "version": "0",
  "result": "",
  "status": "Enum",
  "json": {
    "Id": "string",
    "Customer Name": "string",
    "Amount": "number",
    "email": "string",
    "Invoice Date": "ISO 8601 date and time notation"
  }
}
ステータスの Enum 配列値:
Enum:
[ READY_TO_RUN, DATA_ERROR, UNKNOWN, STAGED, QUEUED, ACTIVE, UNSUCCESSFUL, SUCCESSFUL, ON_HOLD ]

作業項目 作業項目のデータ、結果、ステータスを更新 を更新するための手順を 1 つ 1 つ学ぶには、リンクをクリックします。

キューで作業項目を一覧表示
POST http://<your_control_room_url>/v2/wlm/queues/{id}/workitems/list
URL パラメーター:

.../queues/{id}/...: 作業項目を一覧表示させる WLM キューを特定する数値です。

本文パラメーター: このリクエスト本文の例には、応答を絞り込むためのフィルタ、ソート、ページ管理などが含まれています。
{
  "filter": {
    "operator": "NONE",
    "operands": [
      null
    ],
    "field": "string",
    "value": "string"
  },
  "sort": [
    {
      "field": "string",
      "direction": "asc"
    }
  ],
  "page": {
    "offset": 0,
    "length": 0
  }
}
キューから作業項目を削除
POST http://<your_control_room_url>/v2/wlm/queues/{id}/workitems/delete
URL パラメーター:

.../queues/{id}/...: 作業項目を一覧表示させる WLM キューを特定する数値です。

本文パラメーター:
{
  "workitemIds": [
    0,
    1,
    2
  ]
}

キュー キューから作業項目を削除 から作業項目を削除するための手順を 1 つ 1 つ学ぶには、リンクをクリックします。

フィードバックを送る