AWA ルーティング API

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む4読むのに数分

    • AWA ルーティング API は、ドキュメントをキューにルーティングするためのエンドポイントを提供します。

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

    AWA ルーティング - POST /now/awa/queues/{queue_sys_id}/work_item

    アクティブな作業アイテムが存在する場合、ドキュメントをキューにルーティングします。指定されたドキュメントにアクティブな作業アイテムが存在しない場合は、作業アイテムを作成し、それに応じてフィールドを設定します。

    URL 形式

    バージョニングされた URL：/api/now/{api_version}/awa/queues/{queue_sys_id}/work_item

    デフォルトの URL：/api/now/awa/queues/{queue_sys_id}/work_item

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

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

    データタイプ：文字列
    queue_sys_id キュー [awa_queue] テーブルのキューレコードの sys_id。

    データタイプ：文字列
    表 : 2. クエリパラメーター
    名前 説明
    なし
    表 : 3. 要求本文パラメーター (XML または JSON)
    名前 説明
    document_sys_id キューにルーティングするドキュメントの sys_id。

    データタイプ：文字列
    document_table ドキュメントに関連付けられたテーブルの名前 (インシデントなど)。

    データタイプ：文字列

    ヘッダー

    次のリクエストや応答ヘッダーは、この 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 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    404 見つかりません。要求アイテムが見つかりませんでした。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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

    名前 説明
    display_name この作業アイテムによってルーティングするドキュメントの名前 (ケースレコードなど)。

    データタイプ：文字列
    document_sys_id キューにルーティングするドキュメントの sys_id。

    データタイプ：文字列
    document_table ドキュメントに関連付けられたテーブルの名前。

    データタイプ：文字列
    queue_sys_id ドキュメントをルーティングするキューの sys_id。

    データタイプ：文字列
    sys_id キューにアサインされた作業アイテムの sys_id。

    データタイプ：文字列

    サンプル cURL 要求

    curl -X POST \
  https://instance.servicenow.com/api/now/awa/queues/339eed3f3b892300a2bac9bb34efc4c3/work_item \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-u 'username':'password'
-d '{
  "document_sys_id": "9c573169c611228700193229fff72400",
  "document_table": "incident"
}'
    {
  "result": {
    "sys_id": "cd57f90ddbb26300db2051735e9619f0",
    "document_table": "incident",
    "document_sys_id": "9c573169c611228700193229fff72400",
    "queue_sys_id": "339eed3f3b892300a2bac9bb34efc4c3",
    "display_name": "Incident: INC0000001"
  }
}