---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference
Release :
- xanadu
ft:locale :
- ja-JP
ft:publication_title :
- Xanadu API リファレンス
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# AWA 受信ボックスアクション API
# AWA 受信ボックスアクション API {#ariaid-title1}
* リリースバージョン: Xanadu
*
* 更新日 2024年08月01日
*
*  所要時間：16分
AWA 受信ボックスアクション API は、エージェントの代わりに作業アイテムを承認または却下するためのエンドポイントを提供します。この API は、却下された作業アイテムの却下理由も取得します。
この API には 高度な作業アサイン (com.glide.awa) プラグインと awa_integration_user ロールが必要です。詳細については、 [高度なワークアサインを参照してください](https://www.servicenow.com/docs/access?context=awa-overview&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)。
## AWA 受信ボックスアクション -- GET /awa/inbox/actions/reject_reasons/{channel_id} {#ariaid-title2}
指定されたサービスチャネルの作業アイテムの却下理由を取得します。
### URL 形式
バージョニングされた URL：/api/now/awa/inbox/actions/reject_reasons/{channel_id}
デフォルトの URL：/api/now/{api_version}/awa/inbox/actions/reject_reasons/{channel_id}
### サポートされている要求パラメーター
{#awa-inbox-actions-GET-reasons__entry__2}{#awa-inbox-actions-GET-reasons__version-RESTAPI}
| 名前 | 説明 |
|-|-|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| channel_id | サービスチャネル \[awa_service_channel\] テーブルにリストされたサービスチャネルの sys_id。詳細については、「」を参照してください。 |
[表 : 1. パスパラメーター]
{#awa-inbox-actions-GET-reasons__entry__8}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 2. クエリパラメーター]
{#awa-inbox-actions-GET-reasons__entry__12}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 3. 要求本文パラメーター (XML または JSON)]
### ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#awa-inbox-actions-GET-reasons__entry__16}{#awa-inbox-actions-GET-reasons__accept-RESTAPI}
| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
[表 : 4. 要求ヘッダー]
{#awa-inbox-actions-GET-reasons__entry__20}
| ヘッダー | 説明 |
|-|-|
| なし | |
[表 : 5. 応答ヘッダー]
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#awa-inbox-actions-GET-reasons__entry__24}{#awa-inbox-actions-GET-reasons__entry-200-status-code}{#awa-inbox-actions-GET-reasons__entry-400-status-code}{#awa-inbox-actions-GET-reasons__entry-401-status-code}{#awa-inbox-actions-GET-reasons__entry-403-status-code-awa}{#awa-inbox-actions-GET-reasons__entry-500-status-code}
| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
| 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
| 403 | 禁止されています。 考えられる理由: * ユーザーにawa_integration_userロールがありません。{#awa-inbox-actions-GET-reasons__li-403-role} * glide.awa.enabled プロパティの値が true ではありません。Advanced Work Assignment (com.glide.awa) プラグインがインストールされている場合、このプロパティはシステムのプロパティ \[sys_property\] テーブルにリストされます。詳細については、「 [高度なワークアサインメントとともにインストールされるコンポーネント](https://www.servicenow.com/docs/access?context=installed-with-awa&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)」を参照してください。{#awa-inbox-actions-GET-reasons__li-403-awa-disabled} {#awa-inbox-actions-GET-reasons__ul_gch_n34_tsb} |
| 404 | レコードが見つかりません。指定されたチャネル ID が有効ではありません。 |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
[表 : 6. ステータスコード]
### 応答本文のパラメーター (JSON または XML)
{#awa-inbox-actions-GET-reasons__entry__38}
| 名前 | 説明 |
|-|-|
| display_value | 却下理由 \[awa_reject_reason\] テーブルの Reason フィールドの値を表示します。 データタイプ：文字列 |
| order | 却下理由をエージェントの受信ボックスに表示する順序。 データタイプ：数値 |
| value | データベースに保存されている却下理由フィールドの値。 データタイプ：文字列 |
| Sys_id | このサービスチャネルの却下理由の sys_id。理由は、却下理由 \[awa_reject_reason\] テーブルに一覧表示されます。 データタイプ：文字列 |
[ ]
次の例は、チャットサービスチャネルの却下理由を取得する方法を示しています。
curl "https://instance.service-now.com/api/now/awa/inbox/actions/reject_reasons/27f675e3739713004a905ee515f6a7c3" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
応答本文には、却下されたタスクが却下理由とともに表示されます。
{
"result": [
{
"order": 2,
"value": "Not my expertise",
"display_value": "Not my expertise",
"sys_id": "31e3fa29b38023002e7b6e5f26a8dc17"
},
{
"order": 1,
"value": "Busy",
"display_value": "Busy",
"sys_id": "4e93fa29b38023002e7b6e5f26a8dc20"
}
]
}
## AWA 受信ボックスアクション -- POST /awa/inbox/actions/accept {#ariaid-title3}
エージェントの代わりに \[保留中の承認\] ステータスの作業アイテムを承認します。
### URL 形式
バージョニングされた URL：/api/now/{api_version}/awa/inbox/actions/accept
デフォルトの URL：/api/now/awa/inbox/actions/accept
### サポートされている要求パラメーター
{#awa-inbox-actions-POST-accept__entry__2}{#awa-inbox-actions-POST-accept__version-RESTAPI}
| 名前 | 説明 |
|-|-|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
[表 : 7. パスパラメーター]
{#awa-inbox-actions-POST-accept__entry__6}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 8. クエリパラメーター]
{#awa-inbox-actions-POST-accept__entry__10}{#awa-inbox-actions-POST-accept__awa-api-ph-work_item_id}
| 名前 | 説明 |
|-|-|
| agent_id | ユーザー \[sys_user\] テーブルにリストされているエージェントの sys_id。 データタイプ：文字列 |
| work_item_id | AWA 作業アイテム \[awa_work_item\] テーブルにリストされている作業アイテムの sys_id。 作業アイテムは次の基準を満たしている必要があります。 * 作業アイテムは、指定されたエージェントにアサインされている必要があります。 * 作業アイテムは、\[承認保留中\] ステータスになっている必要があります。 {#awa-inbox-actions-POST-accept__ul_zcs_rh3_htb} データタイプ：文字列 |
[表 : 9. 要求本文パラメーター (XML または JSON)]
### ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#awa-inbox-actions-POST-accept__entry__16}{#awa-inbox-actions-POST-accept__accept-RESTAPI}
| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
[表 : 10. 要求ヘッダー]
{#awa-inbox-actions-POST-accept__entry__20}
| ヘッダー | 説明 |
|-|-|
| なし | |
[表 : 11. 応答ヘッダー]
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#awa-inbox-actions-POST-accept__table_qsk_1hj_mtb__entry__2}{#awa-inbox-actions-POST-accept__entry-200-status-code}{#awa-inbox-actions-POST-accept__ph-404-status-code-awa}{#awa-inbox-actions-POST-accept__entry-401-status-code}{#awa-inbox-actions-POST-accept__entry-403-status-code-awa}{#awa-inbox-actions-POST-accept__entry-500-status-code}
| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 無効な要求。 考えられる理由： * エージェント ID がありません。{#awa-inbox-actions-POST-accept__li-404-reason-missing-agent-awa} {#awa-inbox-actions-POST-accept__li-404-reason-missing-agent-awa} * 作業アイテム ID がありません。{#awa-inbox-actions-POST-accept__li-404-reason-missing-workitem-awa} {#awa-inbox-actions-POST-accept__li-404-reason-missing-workitem-awa} * 作業アイテムが別のエージェントにアサインされています。{#awa-inbox-actions-POST-accept__li-404-reason-agent-assign-awa} {#awa-inbox-actions-POST-accept__li-404-reason-agent-assign-awa} * 作業アイテムが保留中の承認ステータスではありません。{#awa-inbox-actions-POST-accept__li-404-reason-wrkitm-not-pend-awa} {#awa-inbox-actions-POST-accept__li-404-reason-wrkitm-not-pend-awa} {#awa-inbox-actions-POST-accept__ul_khl_t2l_ntb} |
| 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
| 403 | 禁止されています。 考えられる理由: * ユーザーにawa_integration_userロールがありません。{#awa-inbox-actions-POST-accept__li-403-role} * glide.awa.enabled プロパティの値が true ではありません。Advanced Work Assignment (com.glide.awa) プラグインがインストールされている場合、このプロパティはシステムのプロパティ \[sys_property\] テーブルにリストされます。詳細については、「 [高度なワークアサインメントとともにインストールされるコンポーネント](https://www.servicenow.com/docs/access?context=installed-with-awa&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)」を参照してください。{#awa-inbox-actions-POST-accept__li-403-awa-disabled} {#awa-inbox-actions-POST-accept__ul_gch_n34_tsb} |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
[表 : 12. ステータスコード]
{#awa-inbox-actions-POST-accept__table_qsk_1hj_mtb}
### 応答本文のパラメーター (JSON または XML)
{#awa-inbox-actions-POST-accept__entry__36}{#awa-inbox-actions-POST-accept__ordr-row-error}
| 名前 | 説明 |
|-|-|
| documentTable | この作業アイテムにアサインされたドキュメントをリストするテーブルの名前。 データタイプ：文字列 |
| documentSysId | タスクにアサインされたドキュメントレコードの sys_id。documentTable フィールドで指定されたテーブルにあります。 データタイプ：文字列 |
| error | 要求プロセス中に発生したエラーを説明する詳細。 データタイプ：オブジェクト "error": { "detail": "String", "message": "String" } |
| error.detail | 要求プロセス中に発生したエラーの詳細。 可能な値： * エージェント ID がありません:要求本文に agent_id が指定されていません。 * 作業アイテム ID がありません:要求本文に work_item_id が指定されていません。 * 作業アイテムが別のエージェントにアサインされています -- 指定された作業アイテムが指定されたエージェントにアサインされていません。 * 誤った作業アイテム ID：要求本文で指定された作業アイテムが不正確であるか、存在しません。 * 作業アイテムが \[承認保留中\] ステータスではありません -- 要求本文で指定された作業アイテムが \[受入処理待ち\] 以外のステータスになっています。 {#awa-inbox-actions-POST-accept__ul_yqf_jk4_htb} データタイプ：文字列 |
| error.message | 要求プロセス中に発生したエラーのメッセージ。説明は error.detail プロパティで提供されます。 データタイプ：文字列 |
| status | 失敗した要求のステータス。このプロパティは、エラーが発生した場合にのみ応答に含まれます。 有効な値： failure データタイプ：文字列 |
[ ]
### cURL 要求
次の例は、選択したエージェントの作業アイテムのステータスを \[受入処理待ち\] から \[受入済み\] に変更する方法を示しています。
curl "https://instance.service-now.com/api/now/awa/inbox/actions/accept" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"agent_id\":\"46c9e158a9fe198101d44d0d22cb640d\",
\"work_item_id\":\"fd69abfc878b01101ae365b83cbb35fe\"
}" \
--user 'username':'password'
応答本文には、作業アイテムに関連するドキュメントの sys_id とテーブルがリストされます。
{
"result": {
"documentSysId": "57af7aec73d423002728660c4cf6a71c",
"documentTable": "incident"
}
}
## AWA 受信ボックスアクション -- POST /awa/inbox/actions/reject {#ariaid-title4}
エージェントの代わりに \[承認保留中\] ステータスの作業アイテムを却下します。成功すると、\[アサイン先\] フィールドは空になり、指定された作業アイテムの \[却下\] フィールドの値は true になります。
### URL 形式
バージョニングされた URL：/api/now/{api_version}/awa/inbox/actions/reject
デフォルトの URL：/api/now/awa/inbox/actions/reject
### サポートされている要求パラメーター
{#awa-inbox-actions-POST-reject__entry__2}{#awa-inbox-actions-POST-reject__version-RESTAPI}
| 名前 | 説明 |
|-|-|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
[表 : 13. パスパラメーター]
{#awa-inbox-actions-POST-reject__entry__6}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 14. クエリパラメーター]
{#awa-inbox-actions-POST-reject__entry__10}{#awa-inbox-actions-POST-reject__awa-api-ph-work_item_id}
| 名前 | 説明 |
|-|-|
| agent_id | ユーザー \[sys_user\] テーブルにリストされているエージェントの sys_id。 データタイプ：文字列 |
| reject_reason_id | このサービスチャネルの却下理由の sys_id。理由は、却下理由 \[awa_reject_reason\] テーブルに一覧表示されます。 データタイプ：文字列 |
| work_item_id | AWA 作業アイテム \[awa_work_item\] テーブルにリストされている作業アイテムの sys_id。 作業アイテムは次の基準を満たしている必要があります。 * 作業アイテムは、指定されたエージェントにアサインされている必要があります。 * 作業アイテムは、\[承認保留中\] ステータスになっている必要があります。 {#awa-inbox-actions-POST-reject__ul_zcs_rh3_htb} データタイプ：文字列 |
[表 : 15. 要求本文パラメーター (XML または JSON)]
### ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#awa-inbox-actions-POST-reject__entry__18}{#awa-inbox-actions-POST-reject__accept-RESTAPI}
| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
[表 : 16. 要求ヘッダー]
{#awa-inbox-actions-POST-reject__entry__22}
| ヘッダー | 説明 |
|-|-|
| なし | |
[表 : 17. 応答ヘッダー]
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#awa-inbox-actions-POST-reject__entry__26}{#awa-inbox-actions-POST-reject__entry-200-status-code}{#awa-inbox-actions-POST-reject__entry-401-status-code}{#awa-inbox-actions-POST-reject__entry-403-status-code-awa}{#awa-inbox-actions-POST-reject__entry-500-status-code}
| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 無効な要求。 考えられる理由： * エージェント ID がありません。 * 作業アイテム ID がありません。 * 却下理由 ID がありません。 * 作業アイテムが別のエージェントにアサインされています。 * 作業アイテムが保留中の承認ステータスではありません。 {#awa-inbox-actions-POST-reject__ul_khl_t2l_ntb} |
| 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
| 403 | 禁止されています。 考えられる理由: * ユーザーにawa_integration_userロールがありません。{#awa-inbox-actions-POST-reject__li-403-role} * glide.awa.enabled プロパティの値が true ではありません。Advanced Work Assignment (com.glide.awa) プラグインがインストールされている場合、このプロパティはシステムのプロパティ \[sys_property\] テーブルにリストされます。詳細については、「 [高度なワークアサインメントとともにインストールされるコンポーネント](https://www.servicenow.com/docs/access?context=installed-with-awa&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)」を参照してください。{#awa-inbox-actions-POST-reject__li-403-awa-disabled} {#awa-inbox-actions-POST-reject__ul_gch_n34_tsb} |
| 404 | 見つかりません。要求アイテムが見つかりませんでした。 考えられる理由： * 誤ったエージェント ID：指定されたユーザーのレコードがありません。 * 誤った却下理由 ID：指定された却下理由のレコードがありません。 * 誤った作業アイテム ID：指定された作業アイテムのレコードがありません。 {#awa-inbox-actions-POST-reject__ul_g1r_43l_ntb} |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
[表 : 18. ステータスコード]
### 応答本文のパラメーター (JSON または XML)
{#awa-inbox-actions-POST-reject__entry__40}{#awa-inbox-actions-POST-reject__ordr-row-error}
| 名前 | 説明 |
|-|-|
| agent_id | ユーザー \[sys_user\] テーブルにリストされているエージェントの sys_id。 データタイプ：文字列 |
| error | 要求プロセス中に発生したエラーを説明する詳細。 データタイプ：オブジェクト "error": { "detail": "String", "message": "String" } |
| error.detail | 要求プロセス中に発生したエラーの詳細。 可能な値： * エージェント ID がありません -- 要求本文で agent_id が提供されませんでした。 * 却下理由アイテム ID がありません -- 要求本文で reject_reason_id が提供されませんでした。 * 作業アイテム ID がありません:要求本文に work_item_id が指定されていません。 * awa_reject_reason : \ のレコードがありません -- 要求本文に指定された reject_reason_id に一致するレコードが却下理由 \[awa_reject_reason\] テーブルにありません。 * awa_work_item : \ のレコードがありません -- 要求本文で指定された work_item_id に一致するレコードが AWA 作業アイテム \[awa_work_item\] テーブルにありません。 * sys_user : \ のレコードがありません -- 要求本文で指定された agent_id に一致するレコードがユーザー \[sys_user\] テーブルにありません。 * 作業アイテムが保留中の承認ステータスではない:要求本文で指定された作業アイテムが 保留中の承認以外のステータスです。 {#awa-inbox-actions-POST-reject__ul_o5m_22t_gtb} データタイプ：文字列 |
| error.message | 要求プロセス中に発生したエラーのメッセージ。説明は error.detail プロパティで提供されます。 データタイプ：文字列 |
| status | 失敗した要求のステータス。このプロパティは、エラーが発生した場合にのみ応答に含まれます。 有効な値： failure データタイプ：文字列 |
| reject_reason_id | このサービスチャネルの却下理由の sys_id。理由は、却下理由 \[awa_reject_reason\] テーブルに一覧表示されます。 データタイプ：文字列 |
| work_item_id | AWA 作業アイテム \[awa_work_item\] テーブルにリストされている作業アイテムの sys_id。 データタイプ：文字列 |
[ ]
次の例は、アサインされた作業アイテムを「専門知識がありません」という理由で却下する方法を示しています。
curl "https://instance.service-now.com/api/now/awa/inbox/actions/reject" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"agent_id\":\"46c9e158a9fe198101d44d0d22cb640d\",
\"work_item_id\":\"3ed5df4d87cf01101ae365b83cbb35af\",
\"reject_reason_id\":\"31e3fa29b38023002e7b6e5f26a8dc17\"
}" \
--user 'username':'password'
成功した出力には、要求本文で指定されたものと同じ作業アイテム、却下理由、およびユーザー ID が表示されます。AWA 作業アイテム \[awa_work_item\] テーブルの指定された作業アイテムの \[アサイン先\] フィールドは空で、\[却下\] フィールドの値は true です。
{
"result": {
"work_item_id": "3ed5df4d87cf01101ae365b83cbb35af",
"reject_reason_id": "31e3fa29b38023002e7b6e5f26a8dc17",
"agent_id": "46c9e158a9fe198101d44d0d22cb640d"
}
}