---
sourceDocument: オーストラリア API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference
Release :
- australia
ft:locale :
- ja-JP
ft:publication_title :
- オーストラリア API リファレンス
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# アクティビティサブスクリプション API
# アクティビティサブスクリプション API {#ariaid-title1}
* リリースバージョン: Australia
*
* 更新日 2026年03月12日
*
*  所要時間：33分
ActivitySubscriptions API は、サブスクリプションおよびアクティビティフィードフレームワークからアクティビティエンティティを取得するためのエンドポイントを提供します。
この API には、Subscriptions and Activity Feed Framework (com.snc.activity_subscriptions) プラグインのアクティベーションが必要です。顧客セントラル (com.sn_csm_customer_central) プラグインをアクティブ化して、必要なすべてのテーブルで構成をシードします。顧客セントラルの構成設定の詳細については、「 [顧客セントラルの構成](https://www.servicenow.com/docs/access?context=configure-customer-central&version=australia&pubname=australia-customer-service-management&ft:locale=en-US)」を参照してください。
## ActivitySubscriptions:GET /now/actsub/activities {#ariaid-title2}
サブスクリプションおよびアクティビティフィードフレームワークからアクティビティレコードを取得します。
このエンドポイントにアクセスするためにロールは必要ありませんが、返されるデータはユーザーのアクセス設定によって制限されます。
### URL 形式
バージョニングされた URL: /api/now/{api_version}/actsub/activities
デフォルト URL: /api/now/actsub/activities
注:
使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。
### サポートされている要求パラメーター
{#actsub-GET-activities__entry__2}{#actsub-GET-activities__version-not_optional-RESTAPI}
| 名前 | 説明 |
|-|-|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
[表 : 1. パスパラメーター]
{#actsub-GET-activities__entry__6}{#actsub-GET-activities__end-date-query-param-entry}{#actsub-GET-activities__start-date-query-param-entry}
| 名前 | 説明 |
|-|-|
| 次の値より前 | 日付/時刻値。この要求は、この日時より前に作成されたレコードのみを返します。 データタイプ：文字列 形式:YYYY-MM-DD hh:mm:ss または YYYY-MM-DD |
| context | 必須です。アクティビティコンテキストのSys_id。 事前定義されたアクティビティコンテキストには、コンシューマーと連絡先が含まれます。 データタイプ：文字列 テーブル:アクティビティコンテキスト \[sn_actsub_activity_context\] |
| context_instance | 必須です。指定されたアクティビティコンテキストのインスタンスのSys_id。取得するアクティビティのイニシエーターを表します。アクティビティコンテキストの適切なテーブルにあります。 たとえば、 context をコンシューマーアクティビティコンテキストのsys_idに設定する場合は、アクティビティを取得するコンシューマーのコンシューマー \[csm_consumer\] テーブルレコードのsys_idにこのパラメーターを設定します。 データタイプ：文字列 |
| end_date | 日付/時刻値。この要求は、 start_date とこのパラメーターで定義された期間中に作成されたレコードのみを返します。start_dateとともに設定する必要があります。 データタイプ：文字列 形式:YYYY-MM-DD hh:mm:ss または YYYY-MM-DD |
| ファセット | 指定されたアクティビティコンテキストについて取得するアクティビティファセットタイプのsys_idsのカンマ区切りリスト。 アクティビティファセットの詳細については、「 [アクティビティコンテキストのファセットの作成](https://www.servicenow.com/docs/access?context=create-facet-customer-central&version=australia&pubname=australia-customer-service-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 デフォルト:アクティビティコンテキスト用に構成されたすべてのアクティビティファセットタイプを返します。 テーブル:アクティビティファセット \[sn_actsub_facet\] |
| 最終 | 応答本文から除外された最初の結果行のインデックス値。結果の行インデックスは 0 から始まるため、応答本文に含まれる最後の行はインデックスが last-1 の行になります。 たとえば、 `last=5` を設定すると、インデックスが 5 以上の行は省略され、最初の 5 つの結果行 (インデックス値が 0 から 4) のみが返されます。`stFrom=1` および `last=5` を設定すると、最初の結果行がスキップされ、2 番目から 5 番目の結果行 (インデックス値 1 から 4) が返されます。 データタイプ:数値 (整数) デフォルト: com.snc.actsub.activities.api.fetch.limit システムプロパティの値 (デフォルトでは 10)。 |
| record_id | 動的ファセットをレンダリングするときに使用するレコードのSys_id。取得するアクティビティタイプの適切なテーブルにあります。 たとえば、ケースレコードのアクティビティをフェッチする場合は、このパラメーターを問題のケースレコードのsys_idに設定します。 動的ファセットの詳細については、「 [アクティビティコンテキストのファセットの作成」](https://www.servicenow.com/docs/access?context=create-facet-customer-central&version=australia&pubname=australia-customer-service-management&ft:locale=en-US)を参照してください。 データタイプ：文字列 |
| start_date | 日付/時刻値。この要求は、このパラメーターと end_dateで定義された期間中に作成されたレコードのみを返します。end_dateとともに設定する必要があります。 データタイプ：文字列 形式:YYYY-MM-DD hh:mm:ss または YYYY-MM-DD |
| stFrom | 応答本文に含める最初の結果行のインデックス値。結果行インデックスは 0 から始まります。 たとえば、 `stFrom=2` は最初の 2 つの結果行をスキップし、3 行目以降の結果を返します。 データタイプ:数値 (整数) デフォルト：0 |
[表 : 2. クエリパラメーター]
{#actsub-GET-activities__entry__26}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 3. 要求本文パラメーター (XML または JSON)]
### ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#actsub-GET-activities__entry__30}{#actsub-GET-activities__accept-RESTAPI}
| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
[表 : 4. 要求ヘッダー]
{#actsub-GET-activities__entry__34}
| ヘッダー | 説明 |
|-|-|
| なし | |
[表 : 5. 応答ヘッダー]
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#actsub-GET-activities__entry__38}{#actsub-GET-activities__entry-200-status-code}{#actsub-GET-activities__entry-400-status-code}{#actsub-GET-activities__entry-401-status-code}{#actsub-GET-activities__entry-500-status-code}
| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。応答本文 result.message パラメーターは、エラーの性質を説明します。 エラーメッセージの例: * 有効なコンテキストとcontext_instanceが渡されていることを確認してください 。または「 有効なストリームとユーザーが渡されていることを確認してください」 は、要求に context クエリパラメーターと context_instance クエリパラメーターの一方または両方がないことを示します。これらのパラメーターは必須です。 * stFrom を last より大きくすることはできません 。 stFrom クエリパラメーター値が last クエリパラメーター値を超えていることを示します。 * start_dateを入力してください。end_date は、要求に start_date と end_date クエリパラメーターの 1 つのみが含まれており、個別に使用できないことを示します。 * start_date を end_date より先にすることはできません は、指定された start_date クエリパラメーター値が指定された end_date クエリパラメーター値の後に発生することを示します。 * 指定されたコンテキストがシステムで構成されていません 。 context クエリパラメーター値が有効なアクティビティコンテキストを表していないことを示します。 * context_instanceクエリパラメーター値が、指定されたアクティビティコンテキストの有効なインスタンスを表していないことを示す有効なcontext_instanceが渡されていることを確認してください。 {#actsub-GET-activities__ul_cvl_5c4_ylb} |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
[表 : 6. ステータスコード]
### 応答本文のパラメーター (JSON または XML)
{#actsub-GET-activities__entry__48}
| 名前 | 説明 |
|-|-|
| result | 結果オブジェクト。 データタイプ: オブジェクト "result": { "activities": [Array], "message": "String", "status": Number, "stream": "String", "user": "String" } |
| result.activities | オブジェクトのアレイ。各オブジェクトは、指定されたアクティビティコンテキストとコンテキストインスタンスのアクティビティレコードを表します。 データタイプ：オブジェクトのアレイ "activities": [ { "activity_type_id": "String", "content_fields": [Array], "created": "String", "icon": "String", "source_table_name": "String", "subheader_fields": [Array], "subobject_sys_id": "String", "subobject_table_name": "String", "sys_id": "String", "title": "String" } ] |
| result.activities.activity_type_id | このアクティビティレコードのタイプに対応するアクティビティタイプ \[sn_actsub_activity_type\] テーブルからのレコードのSys_id。 データタイプ：文字列 |
| result.activities.content_fields | アクティビティレコードのタイルにコンテンツとして表示するフィールドを表す各オブジェクトが、オブジェクトのアレイ。 データタイプ：オブジェクトのアレイ "content_fields": [ { "deeplink_to_subobject": "String", "display_as_timeago": "String", "label": "String", "show_label": "String", "type": "String", "value": "String" } ] |
| result.activities.content_fields.deeplink_to_subobject | コンテンツフィールドが、このアクティビティが実行されたオブジェクトのレコードへのハイパーリンクとして表示するかどうかを示すフラグ。 有効な値： * true:コンテンツフィールドは、このアクティビティが実行されたオブジェクトのレコードへのハイパーリンクとして表示されます。 * false:コンテンツフィールドは、このアクティビティが実行されたオブジェクトのレコードへのハイパーリンクとして表示されます。 {#actsub-GET-activities__ul_ej4_bj4_ylb} データタイプ：文字列 |
| result.activities.content_fields.display_as_timeago | コンテンツフィールドが前の形式で表示するかどうかを示すフラグ。 有効な値： * true:コンテンツフィールドは前の形式で表示されます。 * false:コンテンツフィールドは前の形式で表示されません。 {#actsub-GET-activities__ul_kj4_bj4_ylb} データタイプ：文字列 |
| result.activities.content_fields.label | コンテンツフィールドのラベル。 データタイプ：文字列 |
| result.activities.content_fields.show_label | このアクティビティレコードのタイルにあるコンテンツフィールド値にコンテンツフィールドラベルを表示するかどうかを示すフラグ。 有効な値： * true:このアクティビティレコードのタイルにあるコンテンツフィールド値に、コンテンツフィールドラベルが表示されます。 * false:このアクティビティレコードのタイルのコンテンツフィールド値にコンテンツフィールドラベルは表示されません。 {#actsub-GET-activities__ul_sj4_bj4_ylb} データタイプ：文字列 |
| result.activities.content_fields.type | コンテンツフィールドのタイプ。 データタイプ：文字列 |
| result.activities.content_fields.value | コンテンツフィールドの値。 データタイプ：文字列 |
| result.activities.created | このアクティビティレコードの作成日時。 データタイプ：文字列 形式:YYYY-DD-MM hh:mm:ss |
| result.activities.icon | このアクティビティレコードのタイルに表示されるアイコンの名前。 データタイプ：文字列 |
| result.activities.source_table_name | このアクティビティレコードが配置されているテーブルの名前。 このアクティビティレコードに関連付けられたタイプのアクティビティタイプ \[sn_actsub_activity_type\] テーブルで定義されたアクティビティソースによって決定されます。 データタイプ：文字列 |
| result.activities.subheader_fields | オブジェクトのアレイ。各オブジェクトは、このアクティビティレコードのタイルのサブヘッダーに表示されるフィールドを表します。 データタイプ：オブジェクトのアレイ "subheader_fields": [ { "deeplink_to_subobject": "String", "display_as_timeago": "String", "label": "String", "show_label": "String", "type": "String", "value": "String" } ] |
| result.activities.subheader_fields.deeplink_to_subobject | サブヘッダーフィールドが、このアクティビティが実行されたオブジェクトのレコードへのハイパーリンクとして表示するかどうかを示すフラグ。 有効な値： * true:サブヘッダーフィールドは、このアクティビティが実行されたオブジェクトのレコードへのハイパーリンクとして表示されます。 * false:サブヘッダーフィールドは、このアクティビティが実行されたオブジェクトのレコードへのハイパーリンクとして表示されません。 {#actsub-GET-activities__ul_ppz_534_ylb} データタイプ：文字列 |
| result.activities.subheader_fields.display_as_timeago | サブヘッダーフィールドを前の形式で表示するかどうかを示すフラグ。 有効な値： * true:サブヘッダーフィールドは前の形式で表示されます。 * false:サブヘッダーフィールドは前の形式で表示されません。 {#actsub-GET-activities__ul_oqv_y34_ylb} データタイプ：文字列 |
| result.activities.subheader_fields.label | サブヘッダーフィールドのラベル。 データタイプ：文字列 |
| result.activities.subheader_fields.show_label | このアクティビティレコードのタイルのサブヘッダーフィールド値にサブヘッダーフィールドラベルを表示するかどうかを示すフラグ。 有効な値： * true:このアクティビティレコードのタイルのサブヘッダーフィールド値にサブヘッダーフィールドラベルが表示されます。 * false:このアクティビティレコードのタイルのサブヘッダーフィールド値にサブヘッダーフィールドラベルは表示されません。 {#actsub-GET-activities__ul_iws_q34_ylb} データタイプ：文字列 |
| result.activities.subheader_fields.type | サブヘッダーフィールドのタイプ。 データタイプ：文字列 |
| result.activities.subheader_fields.value | サブヘッダーフィールドの値。 データタイプ：文字列 |
| result.activities.subobject_sys_id | このアクティビティが実行されたオブジェクトのレコードのSys_id。subobject_table_nameパラメーター値で指定されたテーブルにあります。 データタイプ：文字列 |
| result.activities.subobject_table_name | このアクティビティが実行されたオブジェクトのレコードを含むテーブルの名前。 このアクティビティレコードに関連付けられたアクティビティタイプを含むグループのアクティビティグループ \[sn_actsub_subscribable_object\] テーブルで定義されたテーブル名によって決定されます。 データタイプ：文字列 |
| result.activities.sys_id | このアクティビティレコードのSys_id。source_table_name応答本文のパラメーター値として指定されたテーブルにあります。 データタイプ：文字列 |
| result.activities.title | このアクティビティレコードのタイルに表示されるタイトル。 データタイプ：文字列 |
| result.hasMoreRecords | 応答本文内のアクティビティのリストが last クエリパラメーター値によって切り捨てられるかどうかを示すフラグ。 有効な値： * true:応答本文内のアクティビティのリストは、 last クエリパラメーター値によって切り捨てられます。より高い last クエリパラメーター値で要求を繰り返すと、このコンテキストとコンテキストインスタンスの追加アクティビティが返されます。 * false:応答本文のアクティビティのリストは、 last クエリパラメーター値によって切り捨てられません。このコンテキストおよびコンテキストインスタンスでこれ以上のアクティビティは使用できません。 {#actsub-GET-activities__ul_x24_sf4_ylb} データタイプ：文字列 |
| result.message | 要求の処理中に発生した問題を説明するエラーメッセージ。 データタイプ：文字列 |
| result.status | 要求に対して返された HTTP ステータスコード。 有効な値:「ステータスコード」を参照してください。 データタイプ：数値 |
| result.stream | 要求 context クエリパラメーターで指定されたSys_id。 データタイプ：文字列 テーブル:アクティビティコンテキスト \[sn_actsub_activity_context\] |
| result.user | 要求 context_instance クエリパラメーターで指定されたSys_id。アクティビティコンテキストの適切なテーブルにあります。 データタイプ：文字列 |
[ ]
### cURL 要求
2020 年以降のデータに限定して、特定の連絡先の 2 番目と 3 番目のアクティビティレコードを要求します。
curl "https://instance.servicenow.com/api/now/actsub/activities\
?context=4a6a035a73d30010e37d71ef64f6a714\
&context_instance=ddce70866f9331003b3c498f5d3ee417\
&stFrom=1&last=3\
&start_date=2020-01-01%2000:00:00&end_date=2020-12-31%2023:59:59" \
--request GET \
--header "Accept: application/json" \
--user "username:password"
応答本文には、指定された連絡先に対する 2 つの要求されたアクティビティレコードが含まれます。
{
"result": {
"hasMoreRecords": true,
"activities": [
{
"subobject_table_name": "sn_customerservice_case",
"source_table_name": "sn_customerservice_case",
"content_fields": [
{
"value": "Test",
"show_label": "false",
"type": "string",
"label": "Short description",
"display_as_timeago": "false",
"deeplink_to_subobject": "false"
}
],
"created": "2020-05-29 18:42:16",
"activity_type_id": "baf0aace73530010e37d71ef64f6a748",
"title": "Lamar Wilson created case",
"subobject_sys_id": "1687360e8d819010f87705a074e52ac9",
"icon": "clipboard_outline",
"sys_id": "1687360e8d819010f87705a074e52ac9",
"subheader_fields": [
{
"value": "CS0001007",
"show_label": "false",
"type": "string",
"label": "Number",
"display_as_timeago": "false",
"deeplink_to_subobject": "true"
},
{
"value": "2020-05-29 18:42:16",
"show_label": "false",
"type": "glide_date_time",
"label": "Created",
"display_as_timeago": "true",
"deeplink_to_subobject": "false"
},
{
"value": "",
"show_label": "false",
"type": "reference",
"label": "Assigned to",
"display_as_timeago": "false",
"deeplink_to_subobject": "false"
},
{
"value": "Lamar Wilson",
"show_label": "false",
"type": "reference",
"label": "Contact",
"display_as_timeago": "false",
"deeplink_to_subobject": "false"
}
]
},
{
"subobject_table_name": "kb_knowledge",
"source_table_name": "kb_use",
"content_fields": [
{
"value": "How to Set Up a Broadband Router",
"show_label": "false",
"type": "string",
"label": "Short description",
"display_as_timeago": "false",
"deeplink_to_subobject": "false"
}
],
"created": "2020-05-26 10:00:00",
"activity_type_id": "4a8c329273d30010e37d71ef64f6a7c1",
"title": "Lamar Wilson viewed knowledge article",
"subobject_sys_id": "f855a0a89f011200550bf7b6077fcf4f",
"icon": "document_outline",
"sys_id": "b929dd5873941010e37d71ef64f6a719",
"subheader_fields": [
{
"value": "KB0000110",
"show_label": "false",
"type": "string",
"label": "Number",
"display_as_timeago": "false",
"deeplink_to_subobject": "true"
},
{
"value": "2020-05-26 10:00:00",
"show_label": "false",
"type": "glide_date_time",
"label": "Created",
"display_as_timeago": "true",
"deeplink_to_subobject": "false"
}
]
}
]
}
}
## ActivitySubscriptions - GET /now/actsub/facets/{activity_context}/{context_instance} {#ariaid-title3}
サブスクリプションおよびアクティビティフィードフレームワークからアクティビティコンテキスト用に構成されたファセットを取得します。アクティビティタイプ、グループ、およびコンテキスト設定によって決定される各ファセットのアクティビティ数とデータを表示します。
このエンドポイントにアクセスするには、ユーザーに actsub_user ロールまたは admin ロールが必要です。返されるデータは、ユーザーのアクセス設定によって制限されます。
アクティビティコンテキストファセットの詳細については、「 [アクティビティコンテキストのファセットの作成](https://www.servicenow.com/docs/access?context=create-facet-customer-central&version=australia&pubname=australia-customer-service-management&ft:locale=en-US)」を参照してください。
### URL 形式
バージョニングされた URL: /api/now/{api_version}/actsub/facets/{activity_context}/{context_instance}
デフォルト URL: /api/now/actsub/facets/{activity_context}/{context_instance}
注:
使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。
### サポートされている要求パラメーター
{#actsub-GET-facets__entry__2}{#actsub-GET-facets__version-not_optional-RESTAPI}
| 名前 | 説明 |
|-|-|
| activity_context | アクティビティコンテキストのSys_id。 事前定義されたアクティビティコンテキストには、コンシューマーと連絡先が含まれます。移動先 顧客セントラル顧客アクティビティアクティビティコンテキスト インスタンスに定義されたアクティビティコンテキストの完全なリストを表示します。 データタイプ：文字列 テーブル:アクティビティコンテキスト \[sn_actsub_activity_context\] |
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| context_instance | ファセットを取得するアクティビティのイニシエーターを表す、指定されたアクティビティコンテキストのインスタンスのSys_id。 たとえば、連絡先アクティビティコンテキストのsys_idに activity_context を設定する場合は、このパラメーターを、アクティビティファセットを取得する連絡先の連絡先 \[customer_contact\] レコードのsys_idに設定する必要があります。 データタイプ：文字列 テーブル:アクティビティコンテキスト \[sn_actsub_activity_context\] テーブルのアクティビティコンテキストレコードに指定されたコンテキストテーブル内。 |
[表 : 7. パスパラメーター]
{#actsub-GET-facets__entry__10}{#actsub-GET-facets__end-date-query-param-entry}{#actsub-GET-facets__start-date-query-param-entry}
| 名前 | 説明 |
|-|-|
| end_date | 日付/時刻値。この要求は、 start_date とこのパラメーターで定義された期間中に作成されたレコードのみを返します。start_dateとともに設定する必要があります。 データタイプ：文字列 形式:YYYY-MM-DD hh:mm:ss または YYYY-MM-DD |
| ファセット | 指定されたアクティビティコンテキストについて取得するアクティビティファセットのsys_idsのカンマ区切りリスト。 アクティビティコンテキストに定義されているアクティビティファセットタイプを表示するには、 顧客セントラル顧客アクティビティアクティビティコンテキスト をクリックし、\[ ファセット \] 関連リストを調べます。 データタイプ：文字列 デフォルト:アクティビティコンテキスト用に構成されたすべてのアクティビティファセットを返します。 |
| get_activity_count | 応答本文に各ファセットのアクティビティカウントを含めるかどうかを示すフラグ。 有効な値： * true:ファセットアクティビティカウントを含めます。 * false:ファセットアクティビティカウントを省略します。 {#actsub-GET-facets__ul_zw1_y5n_ylb} データタイプ：ブーリアン デフォルト値：false |
| lazy_load | 応答本文からファセットアクティビティデータとアクティビティカウントを省略してパフォーマンスを向上させるかどうかを示すフラグ。このパラメーターは get_activity_countよりも優先されます。 有効な値： * true:ファセットアクティビティデータとアクティビティカウントを省略します。 * false:ファセットアクティビティデータとアクティビティカウントを取得します。 {#actsub-GET-facets__ul_ph3_kvn_ylb} データタイプ：ブーリアン デフォルト値：false |
| start_date | 日付/時刻値。この要求は、このパラメーターと end_dateで定義された期間中に作成されたレコードのみを返します。end_dateとともに設定する必要があります。 データタイプ：文字列 形式:YYYY-MM-DD hh:mm:ss または YYYY-MM-DD |
[表 : 8. クエリパラメーター]
{#actsub-GET-facets__entry__22}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 9. 要求本文パラメーター (XML または JSON)]
### ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#actsub-GET-facets__entry__26}{#actsub-GET-facets__accept-RESTAPI}
| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
[表 : 10. 要求ヘッダー]
{#actsub-GET-facets__entry__30}
| ヘッダー | 説明 |
|-|-|
| なし | |
[表 : 11. 応答ヘッダー]
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#actsub-GET-facets__entry__34}{#actsub-GET-facets__entry-200-status-code}{#actsub-GET-facets__entry-400-status-code}{#actsub-GET-facets__entry-401-status-code}{#actsub-GET-facets__entry-500-status-code}
| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。応答本文 result.message パラメーターは、エラーの性質を説明します。 エラーメッセージの例: * 有効なアクティビティコンテキストの詳細が渡されていることを確認してください 。 activity_context パスパラメーター値が有効なアクティビティコンテキストを表していないか、 context_instance パスパラメーター値が指定されたアクティビティコンテキストの有効なインスタンスを表していないか、またはその両方を示していることを確認します。 * start_dateを入力してください。end_date は、要求に start_date と end_date クエリパラメーターの 1 つのみが含まれており、個別に使用できないことを示します。 * start_date を end_date より先にすることはできません は、指定された start_date クエリパラメーター値が指定された end_date クエリパラメーター値の後に発生することを示します。 {#actsub-GET-facets__ul_cvl_5c4_ylb} |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
[表 : 12. ステータスコード]
### 応答本文のパラメーター (JSON または XML)
{#actsub-GET-facets__entry__44}
| 名前 | 説明 |
|-|-|
| result | アクティビティファセットのリスト。 データタイプ：オブジェクトのアレイ "result": [ { "activity_count": Number, "children": [Array], "facets": [Array], "icon": "String", "is_dynamic": "String", "message": "String", "name": "String", "status": Number } ] |
| result.activity_count | このファセット (およびその子 (存在する場合) に含まれるアクティビティレコードの数。クエリパラメーター lazy_load false で get_activity_count クエリパラメーターが true の場合にのみ表示されます。 データタイプ：数値 |
| result.children | 各オブジェクトがアクティビティレコード (これが動的ファセットの場合) または子ファセット (これが静的ファセットの場合) を表すオブジェクトのアレイ。 データタイプ：オブジェクトのアレイ "children": [ { "activity_count": Number "facet": "String", "icon": "String", "title": "String" } ] |
| result.children.activity_count | この子ファセット (および子、存在する場合) に含まれるアクティビティレコードの数。lazy_loadクエリパラメーターが false で、get_activity_countクエリパラメーターが true の場合にのみ表示されます。 データタイプ：数値 |
| result.children.created | このアクティビティレコードの作成日時。 データタイプ：文字列 形式:YYYY-MM-DD hh:mm:ss |
| result.children.facet | この子ファセットレコードのSys_id。 データタイプ：文字列 テーブル:アクティビティファセット \[sn_actsub_facet\] |
| result.children.icon | この子ファセットに関連付けられたアイコンの名前。 データタイプ：文字列 |
| result.children.sys_id | このアクティビティレコードのSys_id。親ファセットタイプの適切なテーブルにあります。 たとえば、ケースファセットに含まれるアクティビティレコードには、ケース \[sn_customerservice_case\] テーブルにあるsys_idがあります。 データタイプ：文字列 |
| result.children.metadata | 各オブジェクトに、このファセットタイプのアクティビティファセット \[sn_actsub_facet\] テーブルレコードで構成されたファセットフィールドのアクティビティレコードデータを含むオブジェクトのアレイ。 データタイプ：オブジェクトのアレイ "metadata": [ { "key": "String", "label": "String", "type": "String", "value": "String" } ] |
| result.children.metadata.key | このファセットフィールドの名前。 データタイプ：文字列 |
| result.children.metadata.label | このファセットフィールドのラベル。 データタイプ：文字列 |
| result.children.metadata.type | このファセットフィールドのタイプ。 データタイプ：文字列 |
| result.children.metadata.value | このファセットフィールドの値。 データタイプ：文字列 |
| result.children.title | このアクティビティレコードまたは子ファセットの名前。 データタイプ：文字列 |
| result.facets | このファセットレコードに関連付けられているsys_idsのリスト。動的ファセットの場合、このアレイにはファセット自体のsys_idが含まれます。静的ファセットの場合は、代わりにファセットの子であるすべてのファセットのsys_idsが含まれます。 データタイプ：アレイ "facets": [ "510d7e2e73570010e37d71ef64f6a70d", "bc9bfaaa73570010e37d71ef64f6a771" ] テーブル:アクティビティファセット \[sn_actsub_facet\] |
| result.icon | このファセットに関連付けられているアイコンの名前。 データタイプ：文字列 |
| result.is_dynamic | このファセットが動的ファセットであるかどうかを示すフラグ。この値は、 children 応答本文パラメーターに含まれる情報のタイプを決定します。 可能な値： * true:これは動的なファセットです。children応答本文パラメーター値にはアクティビティレコードの詳細が含まれ、facetsパラメーターには動的ファセットsys_idが含まれます。 * false:これは静的ファセット (ファセットグループ) です。children応答本文パラメーター値には子ファセットが含まれ、facetsパラメーターにはこれらの子ファセットのsys_idsが含まれます。 {#actsub-GET-facets__ul_atr_gnv_ylb} データタイプ：ブーリアン |
| result.message | 要求の処理中に発生した問題を説明するエラーメッセージ。 データタイプ：文字列 |
| result.name | ファセットまたはファセットグループの名前。 データタイプ：文字列 |
| result.status | 要求に対して返された HTTP ステータスコード。 可能な値:ステータスコードの表を参照してください。 データタイプ：数値 |
[ ]
### cURL 要求
連絡先のチャット、電話、およびナレッジ記事のファセットとアクティビティカウントを取得します。
curl "https://instance.servicenow.com/api/now/actsub/facets/4a6a035a73d30010e37d71ef64f6a714/ddce70866f9331003b3c498f5d3ee417\
?get_activity_count=true\
&facets=510d7e2e73570010e37d71ef64f6a70d,bc9bfaaa73570010e37d71ef64f6a771,c72d7e2e73570010e37d71ef64f6a7b8" \
--request GET \
--header "Accept: application/json" \
--user "username:password"
応答本文には、ファセットグループの子として要求された 3 つのファセットが含まれ、アクティビティカウントが表示されます。
{
"result": [
{
"is_dynamic": false,
"name": "Interactions",
"activity_count": 4.0,
"facets": [
"510d7e2e73570010e37d71ef64f6a70d",
"bc9bfaaa73570010e37d71ef64f6a771"
],
"children": [
{
"facet": "510d7e2e73570010e37d71ef64f6a70d",
"icon": "chat_outline",
"activity_count": 2.0,
"title": "Chat"
},
{
"facet": "bc9bfaaa73570010e37d71ef64f6a771",
"icon": "phone_outline",
"activity_count": 2.0,
"title": "Phone"
}
]
},
{
"is_dynamic": false,
"name": "Portal Activity",
"activity_count": 5.0,
"facets": [
"c72d7e2e73570010e37d71ef64f6a7b8"
],
"children": [
{
"facet": "c72d7e2e73570010e37d71ef64f6a7b8",
"icon": "document_outline",
"activity_count": 5.0,
"title": "Knowledge articles"
}
]
}
]
}