AWA エージェント API

オーストラリア API リファレンス

Release

australia

ft:locale

ja-JP

ft:publication_title

オーストラリア API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

AWA エージェント API

リリースバージョン: Australia

更新日 2026年03月12日

所要時間：38分

AWA (Advanced Work Assignment) エージェント API は、エージェントの在席状況、チャネルの可用性、および作業負荷を管理するためのエンドポイントを提供します。

この API には、高度な作業アサイン (com.glide.awa) プラグインと awa_integration_user ロールが必要です。詳細については、「高度なワークアサインメント」を参照してください。

AWA エージェント:GET /now/awa/agents/{user_id}

現在のエージェントの在席状況とチャネルの可用性を返します。

URL 形式

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

デフォルト URL: /api/now/awa/agents/{user_id}

注:

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

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

表 : 1. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
user_id	作業アイテムのSys_id。作業アイテムは次の基準を満たしている必要があります。作業アイテムは指定されたエージェントにアサインされている必要があります。作業アイテムは [ 承認保留中] ステータスである必要があります。データタイプ：文字列テーブル:AWA 作業アイテム [awa_work_item]

表 : 2. クエリパラメーター
名前	説明
なし

表 : 3. 要求本文パラメーター (XML または JSON)
ヘッダー	説明
presence.channels.available	チャネルが利用可能かどうかを示すフラグ。可能な値： true:チャネルが利用可能です。 false:チャネルは利用できません。データタイプ：ブーリアン
presence.channels.sys_id	チャネルsys_id。データタイプ：文字列テーブル:サービスチャネル [awa_service_channel]
presence.sys_id	在席状況sys_id。データタイプ：文字列テーブル:在席状況 [awa_presence_state]

ヘッダー

次の要求ヘッダーと応答ヘッダーは、この 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)

表 : 7. 応答本文のパラメーター (JSON または XML)
パラメーター	説明
エラー	要求プロセス中に発生したエラーを説明する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	要求プロセス中に発生したエラーの詳細。データタイプ：文字列
error.message	要求プロセス中に発生したエラーのメッセージ。各エラーメッセージには、 detail プロパティに対応する説明があります。可能な値： `レコードが見つかりません`:要求本文に指定された情報が不正確であるか、存在しません。 `ユーザーが認証されていません`:ユーザーには awa_integration_user ロールがありません。データタイプ：文字列
プレゼンス	エージェントの現在の在席状況とチャネルに関する情報。データタイプ: オブジェクト `"presence": { "available": Boolean, "channels": [Array], "name": "String", "sys_id": "String" }`
presence.available	エージェントが利用可能かどうかを示すフラグ。可能な値： true:エージェントが利用可能です。 false:エージェントは利用できません。データタイプ：ブーリアン
presence.channels	エージェントとの通信に利用可能なチャネルを説明するオブジェクトのリスト。データタイプ：オブジェクトのアレイ `"channels": [ { "available": Boolean, "name": "String", "sys_id": "String" } ]`
presence.channels.available	チャネルが利用可能かどうかを示すフラグ。可能な値： true:チャネルが利用可能です。 false:チャネルは利用できません。データタイプ：ブーリアン
presence.channels.name	チャットや電話などのチャネル名。データタイプ：文字列
presence.channels.restrict_update	ユーザーが更新を制限できるかどうか、つまり可用性のチャネルを選択できるかどうかを示すフラグ。可能な値： true:ユーザーは、可用性のためにこのチャネルを選択できます。 false:ユーザーは可用性のためにこのチャネルを選択できません。データタイプ：ブーリアン
presence.channels.service_channel_type	チャットなどのサービスチャネルタイプ。可能な値は、インストールされているプラグインによって異なります。データタイプ：文字列
presence.channels.sys_id	チャネルsys_id。データタイプ：文字列テーブル:サービスチャネル [awa_service_channel]
presence.name	エージェントの在席状況の名前。可能な値：利用可能利用不可データタイプ：文字列
presence.restrict_update	ユーザーが更新を制限できるかどうかを示すフラグ。可能な値： true:ユーザーは更新を制限できます。 false:ユーザーは更新を制限できません。データタイプ：ブーリアン
presence.sys_id	在席状況sys_id。データタイプ：文字列テーブル:在席状況 [awa_presence_state]
status	失敗した要求のステータス。このプロパティは、エラーがある場合にのみ応答に含まれます。有効な値: `失敗` データタイプ：文字列
sys_id	エージェントsys_id。データタイプ：文字列
作業アイテム	workItem:イベントに関連付けられている作業アイテムに関する情報。データタイプ：文字列
workItem.document	workItem.document:作業アイテムタスクに関連付けられたドキュメントのリスト。データタイプ：文字列
workItem.document.sys_id	workItem.document.sys_id:作業アイテムタスクにアサインされたドキュメントのSys_id。データタイプ：文字列
workItem.document.table	workItem.document.table:タスクにアサインされたドキュメントテーブルの名前。データタイプ：文字列
workItem.previousWorkItem	workItem.previousWorkItem:同じドキュメント ID の以前の作業アイテムのSys_id。非転送作業アイテムの場合、この値は空です。データタイプ：文字列
workItem.serviceChannel	workItem.serviceChannel:作業アイテムタスクに関連付けられたサービスチャネルのリスト。データタイプ：文字列
workItem.serviceChannel.name	workItem.serviceChannel.name:チャットや電話などのサービスチャネルの名前。データタイプ：文字列
workItem.serviceChannel.sys_id	workItem.serviceChannel.sys_id:サービスチャネルのSys_id。データタイプ：文字列
workItem.size	workItem.size:この作業アイテムがエージェントにアサインされているときに使用されるエージェントのキャパシティ。データタイプ：文字列
workItem.sys_id	workItem.sys_id:承認または提供された作業アイテムのSys_id。データタイプ：文字列
workItem.isQueueTransferred	workItem.isQueueTransferred:作業アイテムがキュー転送されているかどうかを示すフラグ。作業アイテムがキュー転送された場合は true に設定し、そうでない場合は false に設定します。データタイプ：ブーリアン
workitem.isAutoAccepted	workItem.isAutoAccepted:作業アイテムがシステムによって自動的に承認されたかどうかを示すフラグ。作業アイテムが自動承認された場合は true に設定します。データタイプ：ブーリアン

cURL 要求のサンプル

curl -X GET \
https://instance.servicenow.com/api/now/awa/agents/46d44a23a9fe19810012d100cca80666 \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password'\

{
  "result": {
    "presence": {
      "name": "Available",
      "sys_id": "0b10223c57a313005baaaa65ef94f970",
      "available": true,
      "channels": [
        {
          "name": "Chat",
          "available": true,
          "sys_id": "27f675e3739713004a905ee515f6a7c3"
        }
      ]
    },
    "sys_id": "46d44a23a9fe19810012d100cca80666"
  }
}

AWA エージェント:GET /now/awa/agents/{user_id}/capacityities

エージェントのチャネルキャパシティ、ユニバーサルキャパシティ、および現在の作業負荷を返して、エージェントがケースを処理できるかどうかを確認します。

AWA エージェント:PUT /now/awa/agents/{user_id}/capacityities メソッドを使用して、エージェントのチャネルキャパシティとユニバーサルキャパシティを変更します。

URL 形式

バージョニングされた URL: /api/now/{api_version}/awa/agents/{user_id}/capacityities

デフォルト URL: /api/now/awa/agents/{user_id}/capacityities

注:

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

表 : 8. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
user_id	リストされたエージェントのSys_id。データタイプ：文字列テーブル：ユーザー [sys_user]

表 : 9. クエリパラメーター
名前	説明
なし

表 : 10. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

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

表 : 12. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

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

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


名前	説明
チャネル	エージェントとの通信に利用可能なチャネルを説明するオブジェクトのリスト。 `"channels": [ { "channel_sys_id": "String", "current_workload": Number, "max_capacity": Number } ]` データタイプ：アレイ
channels.channel_sys_id	チャネルsys_id。データタイプ：文字列テーブル:サービスチャネル [awa_service_channel]
channels.current_workload	現在エージェントにアサインされている特定のサービスチャネルの作業アイテムの数。データタイプ：数値
channels.max_capacity	エージェントを一度にアクティブにアサインできる特定のサービスチャネルの最大作業負荷。データタイプ：文字列
エラー	要求プロセス中に発生したエラーを説明する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	要求プロセス中に発生したエラーの詳細。データタイプ：文字列
error.message	要求プロセス中に発生したエラーのメッセージ。説明は error.detail プロパティに入力されます。データタイプ：文字列
status	失敗した要求のステータス。このプロパティは、エラーがある場合にのみ応答に含まれます。有効な値: `失敗` データタイプ：文字列
universal_capacity	すべてのサービスチャネルにおけるエージェントの最大キャパシティ。エージェントの現在の作業負荷が最大ユニバーサルキャパシティと等しい場合、追加の作業アイテムはエージェントに割り当てられません。このプロパティは、このエージェントのユニバーサルキャパシティレコードが存在する場合にのみ返されます。データタイプ：数値
universal_workload	指定されたエージェントに現在アサインされているすべてのサービスチャネルにわたる作業アイテムの数。このプロパティは、エージェントのユニバーサルキャパシティレコードが存在する場合にのみ返されます。データタイプ：数値

cURL 要求のサンプル

次の例は、ユーザーのキャパシティと作業負荷の値を取得する方法を示しています。

curl "https://instance.service-now.com/api/now/awa/agents/46d44a23a9fe19810012d100cca80666/capacities" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

成功した応答には、各チャネルのキャパシティ値と作業負荷が含まれます。

{
  "result": {
    "universal_workload": 2,
    "channels": [
      {
        "channel_sys_id": "27f675e3739713004a905ee515f6a7c3",
        "current_workload": 2,
        "max_capacity": 4
      }
    ],
    "universal_capacity": 10
  }
}

AWA エージェント:GET /now/awa/agents/{user_id}/presence_states

エージェントの在席状況を返し、エージェントが対応可能か別の在席状況かを示します。

URL 形式

バージョニングされた URL: /api/now/{api_version}/awa/agents/{user_id}/presence_states

デフォルト URL: /api/now/awa/agents/{user_id}/presence_states

注:

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

表 : 14. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
user_id	リストされたエージェントのSys_id。データタイプ：文字列テーブル：ユーザー [sys_user]

表 : 15. クエリパラメーター
名前	説明
なし

表 : 16. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

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

表 : 18. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

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

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


名前	説明
エラー	要求プロセス中に発生したエラーを説明する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	要求プロセス中に発生したエラーの詳細。データタイプ：文字列
error.message	要求プロセス中に発生したエラーのメッセージ。説明は error.detail プロパティに入力されます。データタイプ：文字列
<在席状況>	エージェントの在席状況定義をオブジェクトとしてリストします。各オブジェクトはステータスを記述し、エージェントのチャネルを含みます。データタイプ：アレイ `{ "available": Boolean, "channels": [Array], "disable_inactivity_check": Boolean, "name": "String", "show_channels": Boolean, "sys_id": "String" }`
<プレゼンスステータス>.available	エージェントが利用可能かどうかを示すフラグ。可能な値： true:エージェントが利用可能です。 false:エージェントは利用できません。データタイプ：ブーリアン
<プレゼンスステータス>.channels	エージェントとの通信に利用可能なチャネルを説明するオブジェクトのリスト。データタイプ：アレイ `"channels": [ { "available": Boolean, "name": "String", "restrict_update": Boolean, "service_channel_type": "String", "sys_id": "String" } ]`
<プレゼンスステータス>.channels.available	チャネルが利用可能かどうかを示すフラグ。可能な値： true:チャネルが利用可能です。 false:チャネルは利用できません。データタイプ：ブーリアン
<在席状況>.channels.name	チャットや電話などのチャネル名。データタイプ：文字列
<プレゼンスステータス>.channels.sys_id	チャネルsys_id。データタイプ：文字列テーブル:サービスチャネル [awa_service_channel]
<在席状況>.disable_inactivity_check	この在席状況の非アクティブを確認するかどうかを示すフラグ。有効な値： true:在席状況の非アクティビティチェックは無効です。 false:在席状況の非アクティビティチェックが有効です。データタイプ：ブーリアンデフォルト値：false この設定を変更する方法については、「エージェントの在席状況の構成」を参照してください。
<プレゼンスステータス>.name	エージェントの在席状況の名前。デフォルトでインストールされる在席状況は、`対応可能`、`不在、オフラインです`。データタイプ：文字列
<プレゼンスステータス>.order	エージェントの受信ボックスでこの状況を表示する順番。データタイプ：数値
<在席状況>.show_channels	エージェントが在席状況を変更する権限を持っているかどうか (たとえば、対応可能から退席中など) を示すフラグ。有効な値： true:ユーザーにプレゼンスを変更する権限があります。 false:ユーザーはプレゼンスの変更を制限されています。データタイプ：ブーリアン
<プレゼンスステータス>.sys_id	在席状況sys_id。データタイプ：文字列テーブル:在席状況 [awa_presence_state]
status	失敗した要求のステータス。このプロパティは、エラーがある場合にのみ応答に含まれます。有効な値: `失敗` データタイプ：文字列

cURL 要求のサンプル

次の例は、指定したエージェントの在席状況を取得する方法を示しています。

curl "https://instance.service-now.com/api/now/awa/agents/46d44a23a9fe19810012d100cca80666/presence_states" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

応答本文には、エージェントの考えられる在席状況が一覧表示され、エージェントが利用可能であることが示されます。

{
  "result": [
    {
      "name": "Available",
      "order": 0,
      "show_channels": false,
      "sys_id": "0b10223c57a313005baaaa65ef94f970",
      "available": true,
      "channels": [
        {
          "name": "Chat",
          "available": true,
          "sys_id": "27f675e3739713004a905ee515f6a7c3",
          "restrict_update": false,
          "service_channel_type": "chat"
        }
      ],
      "disable_inactivity_check": false
    },
    {
      "name": "Away",
      "order": 1000,
      "show_channels": false,
      "sys_id": "41f9b8dfb31313005baa6e5f26a8dcac",
      "available": false,
      "channels": [],
      "disable_inactivity_check": false
    },
    {
      "name": "Offline",
      "order": 2000,
      "show_channels": false,
      "sys_id": "9cd83267575313005baaaa65ef94f98b",
      "available": false,
      "channels": [],
      "disable_inactivity_check": false
    }
  ]
}

AWA エージェント:PUT /now/awa/agents/{user_id}

指定されたエージェントの在席状況を設定します。指定されている場合は、そのステータスに対するエージェントのチャネルの可用性を設定します。

URL 形式

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

デフォルト URL: /api/now/awa/agents/{user_id}

注:

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

表 : 20. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
user_id	エージェントのSys_id。データタイプ：文字列テーブル：ユーザー [sys_user]

表 : 21. クエリパラメーター
名前	説明
なし

表 : 22. 要求本文パラメーター (XML または JSON)
名前	説明
presence.channels	エージェントが利用できるチャネルを定義するオブジェクトのリスト。データタイプ：オブジェクトのアレイ `"channels": [ { "available": Boolean, "sys_id": "String" } ]`
presence.channels.available	チャネルが利用可能かどうかを示すフラグ。可能な値： true:チャネルが利用可能です。 false:チャネルは利用できません。注: 応答本文にチャネルを含めるには、この設定を指定する必要があります。データタイプ：ブーリアンデフォルト値：false
presence.channels.sys_id	チャネルsys_id。データタイプ：文字列テーブル:サービスチャネル [awa_service_channel]
presence.sys_id	在席状況sys_id。データタイプ：文字列テーブル:在席状況 [awa_presence_state]

ヘッダー

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

表 : 24. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

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

表 : 26. 応答本文のパラメーター (JSON または XML)
パラメーター	説明
エラー	要求プロセス中に発生したエラーを説明する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	要求プロセス中に発生したエラーの詳細。データタイプ：文字列
error.message	要求プロセス中に発生したエラーのメッセージ。各エラーメッセージには、 detail プロパティに対応する説明があります。可能な値： `レコードが見つかりません`:要求本文に指定された情報が不正確であるか、存在しません。 `ユーザーが認証されていません`:ユーザーには awa_integration_user ロールがありません。データタイプ：文字列
プレゼンス	エージェントの現在の在席状況とチャネルに関する情報。データタイプ: オブジェクト `"presence": { "available": Boolean, "channels": [Array], "name": "String", "sys_id": "String" }`
presence.available	エージェントが利用可能かどうかを示すフラグ。可能な値： true:エージェントが利用可能です。 false:エージェントは利用できません。データタイプ：ブーリアン
presence.channels	エージェントとの通信に利用可能なチャネルを説明するオブジェクトのリスト。データタイプ：オブジェクトのアレイ `"channels": [ { "available": Boolean, "name": "String", "sys_id": "String" } ]`
presence.channels.available	チャネルが利用可能かどうかを示すフラグ。可能な値： true:チャネルが利用可能です。 false:チャネルは利用できません。データタイプ：ブーリアン
presence.channels.name	チャットや電話などのチャネル名。データタイプ：文字列
presence.channels.restrict_update	ユーザーが更新を制限できるかどうか、つまり可用性のチャネルを選択できるかどうかを示すフラグ。可能な値： true:ユーザーは、可用性のためにこのチャネルを選択できます。 false:ユーザーは可用性のためにこのチャネルを選択できません。データタイプ：ブーリアン
presence.channels.service_channel_type	チャットなどのサービスチャネルタイプ。可能な値は、インストールされているプラグインによって異なります。データタイプ：文字列
presence.channels.sys_id	チャネルsys_id。データタイプ：文字列テーブル:サービスチャネル [awa_service_channel]
presence.name	エージェントの在席状況の名前。可能な値：利用可能利用不可データタイプ：文字列
presence.restrict_update	ユーザーが更新を制限できるかどうかを示すフラグ。可能な値： true:ユーザーは更新を制限できます。 false:ユーザーは更新を制限できません。データタイプ：ブーリアン
presence.sys_id	在席状況sys_id。データタイプ：文字列テーブル:在席状況 [awa_presence_state]
status	失敗した要求のステータス。このプロパティは、エラーがある場合にのみ応答に含まれます。有効な値: `失敗` データタイプ：文字列
sys_id	エージェントsys_id。データタイプ：文字列
作業アイテム	workItem:イベントに関連付けられている作業アイテムに関する情報。データタイプ：文字列
workItem.document	workItem.document:作業アイテムタスクに関連付けられたドキュメントのリスト。データタイプ：文字列
workItem.document.sys_id	workItem.document.sys_id:作業アイテムタスクにアサインされたドキュメントのSys_id。データタイプ：文字列
workItem.document.table	workItem.document.table:タスクにアサインされたドキュメントテーブルの名前。データタイプ：文字列
workItem.previousWorkItem	workItem.previousWorkItem:同じドキュメント ID の以前の作業アイテムのSys_id。非転送作業アイテムの場合、この値は空です。データタイプ：文字列
workItem.serviceChannel	workItem.serviceChannel:作業アイテムタスクに関連付けられたサービスチャネルのリスト。データタイプ：文字列
workItem.serviceChannel.name	workItem.serviceChannel.name:チャットや電話などのサービスチャネルの名前。データタイプ：文字列
workItem.serviceChannel.sys_id	workItem.serviceChannel.sys_id:サービスチャネルのSys_id。データタイプ：文字列
workItem.size	workItem.size:この作業アイテムがエージェントにアサインされているときに使用されるエージェントのキャパシティ。データタイプ：文字列
workItem.sys_id	workItem.sys_id:承認または提供された作業アイテムのSys_id。データタイプ：文字列
workItem.isQueueTransferred	workItem.isQueueTransferred:作業アイテムがキュー転送されているかどうかを示すフラグ。作業アイテムがキュー転送された場合は true に設定し、そうでない場合は false に設定します。データタイプ：ブーリアン
workitem.isAutoAccepted	workItem.isAutoAccepted:作業アイテムがシステムによって自動的に承認されたかどうかを示すフラグ。作業アイテムが自動承認された場合は true に設定します。データタイプ：ブーリアン

curl -X PUT \
 https://instance.servicenow.com/api/now/awa/agents/46d44a23a9fe19810012d100cca80666 \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password'\
-d '{"presence": {\
  "sys_id": "0b10223c57a313005baaaa65ef94f970",\
  "channels": [{ \
  "sys_id": "0bbdedbb3b892300a2bac9bb34efc445",\
  "available": true
}] 
}}

{
  "result": {
    "presence": {
      "name": "Available",
      "sys_id": "0b10223c57a313005baaaa65ef94f970",
      "available": true,
      "channels": [
        {
          "name": "Chat",
          "available": true,
          "sys_id": "27f675e3739713004a905ee515f6a7c3"
        }
      ]
    },
    "sys_id": "46d44a23a9fe19810012d100cca80666"
  }
}

AWA エージェント:PUT /now/awa/agents/{user_id}/capacityities

チャネルキャパシティとユニバーサルキャパシティに対するエージェントの最大キャパシティ (作業負荷) の更新を有効にします。

AWA エージェント:GET /now/awa/agents/{user_id}/capacityities メソッドを使用して、エージェントの現在のチャネルとユニバーサルキャパシティを取得します。

URL 形式

バージョニングされた URL: /api/now/{api_version}/awa/agents/{user_id}/capacityities

デフォルト URL: /api/now/awa/agents/{user_id}/capacityities

注:

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

表 : 27. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
user_id	リストされたエージェントのSys_id。データタイプ：文字列テーブル：ユーザー [sys_user]

表 : 28. クエリパラメーター
名前	説明
なし

表 : 29. 要求本文パラメーター (XML または JSON)
名前	説明
チャネル	指定されたエージェントの 1 つ以上のチャネルの最大値を更新する場合は必須です。エージェントに割り当てられた各チャネルの最大キャパシティにチャネルをマッピングする 1 つ以上のキーと値のペアを含む JSON オブジェクト。データタイプ: オブジェクトペアは次の形式になります。キー (チャネル sys_id) – チャネルsys_id。データタイプ：文字列値 (最大キャパシティ) – エージェントを一度にアクティブにアサインできる特定のサービスチャネルの最大作業負荷。データタイプ：数値 `channels: {"<channel_sys_id>": <max_capacity>}`
universal_capacity	ユニバーサルキャパシティを更新する場合は必須です。すべてのサービスチャネルにおけるエージェントの最大キャパシティ。エージェントの現在の作業負荷が最大ユニバーサルキャパシティと等しい場合、追加の作業アイテムはエージェントに割り当てられません。データタイプ：数値

ヘッダー

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

表 : 31. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 32. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
404	見つかりません。要求されたアイテムが見つかりませんでした。

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


名前	説明
チャネル	エージェントとの通信に利用可能なチャネルを説明するオブジェクトのリスト。 `"channels": [ { "channel_sys_id": "String", "max_capacity": Number } ]` データタイプ：アレイ
channels.channel_sys_id	チャネルsys_id。データタイプ：文字列テーブル:サービスチャネル [awa_service_channel]
channels.max_capacity	エージェントを一度にアクティブにアサインできる特定のサービスチャネルの最大作業負荷。データタイプ：文字列
エラー	要求プロセス中に発生したエラーを説明する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	要求プロセス中に発生したエラーの詳細。データタイプ：文字列
error.message	要求プロセス中に発生したエラーのメッセージ。説明は error.detail プロパティに入力されます。データタイプ：文字列
status	失敗した要求のステータス。このプロパティは、エラーがある場合にのみ応答に含まれます。有効な値: `失敗` データタイプ：文字列
universal_capacity	すべてのサービスチャネルにおけるエージェントの最大キャパシティ。エージェントの現在の作業負荷が最大ユニバーサルキャパシティと等しい場合、追加の作業アイテムはエージェントに割り当てられません。このプロパティは、このエージェントのユニバーサルキャパシティレコードが存在する場合にのみ返されます。データタイプ：数値

cURL 要求のサンプル

次の例は、指定したチャネルのエージェントのユニバーサルキャパシティと最大キャパシティを変更する方法を示しています。

curl "https://instance.service-now.com/api/now/awa/agents/46d44a23a9fe19810012d100cca80666/capacities" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
 \"channels\": { \"27f675e3739713004a905ee515f6a7c3\": 6 },
 \"universal_capacity\" : 12
}" \
--user 'username':'password'

成功した応答には、更新されたキャパシティ値が含まれます。

{
  "result": {
    "channels": [
      {
        "channel_sys_id": "27f675e3739713004a905ee515f6a7c3",
        "max_capacity": 6
      }
    ],
    "universal_capacity": 12
  }
}