AWA エージェントコンサルト API

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：5分

    • エージェントコンサルト作業アイテムを処理します。

    この API には、 高度な作業アサイン プラグイン (com.glide.awa) と awa_integration_user ロールが必要です。

    AWAの詳細については、「高度なワークアサインメント」を参照してください。

    AWA オファー作業 APIを使用して、エージェントまたはキューへのコンサルト転送を開始します。

    AWA エージェントコンサルト:PUT /now/awa/consult/end

    コンサルト作業アイテムを終了します。

    ドキュメントがコンサルトがエージェントに転送される場合は、それぞれの作業アイテムを適切なコンサルトステータス ( [転送済み] または [終了済み] ) でクローズする必要があります。

    作業アイテムは、AWA エージェントによって最初から最後まで処理される 1 つの作業です。作業アイテムは、インタラクションやタスクなどのドキュメントに基づいて作成されます。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/awa/consult/end

    デフォルト URL: /api/now/awa/consult/end

    注:
    使用可能なバージョン は、REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

    サポートされている要求パラメーター

    表 : 1. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 2. クエリパラメーター
    名前 説明
    なし
    表 : 3. 要求本文パラメーター (JSON または XML)
    名前 説明
    document_sys_id コンサルト作業アイテムに関連付けられたドキュメントのSys_id。

    ドキュメントとは、インタラクション、ケース、インシデントなど、テーブル内の任意のレコードのことです。

    データタイプ：文字列
    hand_over コンサルト転送を終了または転送する必要があるかどうかを示すフラグ。
    有効な値：
    • true:ドキュメントをコンサルトエージェントに転送し、コンサルト作業アイテムのコンサルトステータスを [転送済み] に設定します。
    • false:コンサルトの転送を終了し、コンサルト作業アイテムのコンサルト状況を[終了] に設定します。
    注:
    コンサルト作業アイテムのコンサルトステータスが [要求済み] の場合、ステータスは [キャンセル] に変わります。

    データタイプ：ブーリアン

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    403 禁止されました。
    考えられる理由:
    • ユーザーにawa_integration_userロールがありません。
    • glide.awa.enabled プロパティの値が true ではありません。高度なワークアサインメント (com.glide.awa) プラグインがインストールされている場合、このプロパティはシステムのプロパティ [sys_property] テーブルにリストされます。詳細については、「 高度なワークアサインメントとともにインストールされるコンポーネント」を参照してください。
    404 見つかりません。要求されたアイテムが見つかりませんでした。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    成功 終了したコンサルトが成功したかどうかを示すフラグ。
    有効な値：
    • true:終了コンサルトは成功しています。
    • false:終了相談に失敗しました。

    データタイプ：ブーリアン
    メッセージ 終了コンサルトの成功または失敗の情報。
    可能な値：
    • 相談が正常に終了しました。 – 成功。
    • 次のドキュメント ID の作業アイテムが見つかりません:<api_caller_sys_id> :ドキュメントのアクティブなコンサルト作業アイテムが存在することを確認します。

    データタイプ：文字列

    cURL 要求のサンプル

    curl "https://instance.servicenow.com/api/now/awa/consult/end" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data '{
    "document_sys_id": "59616aba87bd5210be070d48dabb35e6",
    "hand_over": "true"
}' \
--user 'username':'password'
    {
  "result": {
    "success": true,
    "message": "Consult is successfully ended."
  }
}