ActivitySubscriptions API

ワシントンDC API リファレンス

Release

washingtondc

ft:locale

ja-JP

ft:publication_title

ワシントンDC API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

ActivitySubscriptions API

リリースバージョン: Washingtondc

更新日 2024年02月01日

読む33読むのに数分

ActivitySubscriptions API は、サブスクリプションおよびアクティビティフィードフレームワークからアクティビティエンティティを取得するためのエンドポイントを提供します。

この API では、Subscriptions and Activity Feed Framework (com.snc.activity_subscriptions) プラグインを有効にする必要があります。Customer Central (com.sn_csm_customer_central) プラグインを有効にして、必要なすべてのテーブルで構成をシードします。顧客セントラルの構成設定の詳細については、「顧客セントラルの構成」を参照してください。

ActivitySubscriptions - GET /now/actsub/activities

サブスクリプションとアクティビティフィードフレームワークからアクティビティレコードを取得します。

このエンドポイントにアクセスするためにロールは必要ありませんが、返されるデータはユーザーアクセス設定によって制限されます。

URL 形式

バージョニングされた URL：/api/now/{api_version}/actsub/activities

デフォルトの URL：/api/now/actsub/activities

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

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

表 : 2. クエリパラメーター
名前	説明
before	日付/時刻値。要求は、この日時より前に作成されたレコードのみを返します。データタイプ：文字列形式：YYYY-MM-DD hh:mm:ss または YYYY-MM-DD
コンテキスト	必須です。アクティビティコンテキストの 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
facets	指定されたアクティビティコンテキストについて取得するアクティビティファセットタイプの sys_id のカンマ区切りリスト。これらの sys_id は、アクティビティファセット [sn_actsub_facet] テーブルにあります。アクティビティファセットの詳細については、「アクティビティコンテキストのファセットの作成」を参照してください。データタイプ：文字列デフォルト：アクティビティコンテキストに構成されているすべてのアクティビティファセットタイプを返します。
last	応答本文から省略される結果行の先頭になるインデックス値。結果行のインデックスは 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 に設定します。動的ファセットの詳細については、「アクティビティコンテキストのファセットの作成」を参照してください。データタイプ：文字列
start_date	日付/時刻値。この要求は、このパラメーターと end_date で定義した期間中に作成されたレコードのみを返します。end_date とともに設定する必要があります。データタイプ：文字列形式：YYYY-MM-DD hh:mm:ss または YYYY-MM-DD
stFrom	応答本文に含める最初の結果行のインデックス値。結果行のインデックスは 0 から始まります。たとえば、「`stFrom=2`」は最初の 2 つの結果行をスキップし、3 行目以降の結果を返します。データタイプ：数値 (整数) デフォルト：0

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

ヘッダー

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

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

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

ステータスコード

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

表 : 6. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。応答本文 result.message パラメーターは、エラーの性質を示します。エラーメッセージの例： `[有効なコンテキストと context_instance が渡されていることを確認してください]` または `[有効なストリームとユーザーが渡されていることを確認してください (Make sure a valid stream and user are passed)]` は、要求で context と context_instance のいずれかまたは両方のクエリパラメーターが不足していることを示します。これらのパラメーターは必須です。 `[stFrom を最後より大きくすることはできません]` は、stFrom クエリパラメーターの値が last クエリパラメーターの値を超えていることを示します。 `[start_date と end_date を入力してください]` は、要求に start_date と end_date のいずれかのクエリパラメーターしか含まれていないことを示します。これのパラメーターは別々に使用することはできません。 `[start_date を end_date より後にすることはできません]` は、指定された start_date クエリパラメーター値が、指定された end_date クエリパラメーター値の後に存在することを示します。 `[指定されたコンテキストがシステムに構成されていません]` は、context クエリパラメーター値が有効なアクティビティコンテキストを表していないことを示します。 `[有効な context_instance が渡されていることを確認してください]` は、context_instance クエリパラメーター値が、指定されたアクティビティコンテキストの有効なインスタンスを表していないことを示します。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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


名前	説明
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：コンテンツフィールドが、このアクティビティが実行されたオブジェクトのレコードへのハイパーリンクとして表示されません。データタイプ：文字列
result.activities.content_fields.display_as_timeago	コンテンツフィールドを「～前」の形式で表示するかどうかを示すフラグ。有効な値： true：コンテンツフィールドは「～前」の形式で表示されます。 false：コンテンツフィールドは「～前」の形式で表示されません。データタイプ：文字列
result.activities.content_fields.label	コンテンツフィールドのラベル。データタイプ：文字列
result.activities.content_fields.show_label	このアクティビティレコードのタイルのコンテンツフィールド値にコンテンツフィールドラベルを表示するかどうかを示すフラグ。有効な値： true：このアクティビティレコードのタイルのコンテンツフィールド値にコンテンツフィールドラベルを表示します。 false：このアクティビティレコードのタイルのコンテンツフィールド値にコンテンツフィールドラベルを表示しません。データタイプ：文字列
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：サブヘッダーフィールドが、このアクティビティが実行されたオブジェクトのレコードへのハイパーリンクとして表示されません。データタイプ：文字列
result.activities.subheader_fields.display_as_timeago	サブヘッダーフィールドを前の形式で表示するかどうかを示すフラグ。有効な値： true：サブヘッダーフィールドは前の形式で表示されます。 false：サブヘッダーフィールドは前の形式で表示されません。データタイプ：文字列
result.activities.subheader_fields.label	サブヘッダーフィールドのラベル。データタイプ：文字列
result.activities.subheader_fields.show_label	このアクティビティレコードのタイルのサブヘッダーフィールド値にサブヘッダーフィールドラベルを表示するかどうかを示すフラグ。有効な値： true：このアクティビティレコードのタイルのサブヘッダーフィールド値にサブヘッダーフィールドラベルを表示します。 false：このアクティビティレコードのタイルのサブヘッダーフィールド値にサブヘッダーフィールドラベルを表示しません。データタイプ：文字列
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 クエリパラメーター値で切り捨てられません。このコンテキストとコンテキストインスタンスでは、これ以上のアクティビティを使用できません。データタイプ：文字列
result.message	要求の処理中に発生した問題を説明するエラーメッセージ。データタイプ：文字列
result.status	要求に対して返された HTTP ステータスコード。有効な値：「ステータスコード」を参照してください。データタイプ：数値
result.stream	要求 context クエリパラメーターで指定された sys_id。アクティビティコンテキスト [sn_actsub_activity_context] テーブルにあります。データタイプ：文字列
result.user	要求 context_instance クエリパラメーターで指定された sys_id。アクティビティコンテキストの適切なテーブルにあります。データタイプ：文字列

cURL 要求

特定の連絡先の 2 番目と 3 番目のアクティビティレコードを、2020 年からのデータに限定して要求します。

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}

サブスクリプションとアクティビティフィードフレームワークから、アクティビティコンテキストに構成されたファセットを取得します。アクティビティタイプ、グループ、およびコンテキスト設定によって決定された各ファセットのアクティビティ数とデータを表示します。

ユーザーがこのエンドポイントにアクセスするには、actsub_user または admin ロールが必要です。返されるデータはユーザーアクセス設定によって制限されます。

アクティビティコンテキストファセットの詳細については、「アクティビティコンテキストのファセットの作成」を参照してください。

URL 形式

バージョニングされた URL： /api/now/{api_version}/actsub/facets/{activity_context}/{context_instance}

デフォルトの URL：/api/now/actsub/facets/{activity_context}/{context_instance}

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

表 : 7. パスパラメーター
名前	説明
activity_context	アクティビティコンテキストの sys_id。アクティビティコンテキスト [sn_actsub_activity_context] テーブルにあります。事前定義済みのアクティビティコンテキストには、コンシューマーと連絡先が含まれます。移動先顧客セントラル > 顧客アクティビティ > アクティビティコンテキストをクリックして、インスタンスに定義されているアクティビティコンテキストの完全なリストを表示します。データタイプ：文字列
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、`v1` や `v2`。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
context_instance	ファセットを取得するアクティビティのイニシエーターを表す、指定されたアクティビティコンテキストのインスタンスの sys_id。アクティビティコンテキスト [sn_actsub_activity_context] テーブルのアクティビティコンテキストレコードに指定されたコンテキストテーブルにあります。たとえば、activity_context を連絡先アクティビティコンテキストの sys_id に設定する場合は、このパラメーターを、アクティビティファセットを取得する連絡先の連絡先 [customer_contact] レコードの sys_id に設定します。データタイプ：文字列

表 : 8. クエリパラメーター
名前	説明
end_date	日付/時刻値。この要求は、start_date とこのパラメーターで定義した期間中に作成されたレコードのみを返します。start_date とともに設定する必要があります。データタイプ：文字列形式：YYYY-MM-DD hh:mm:ss または YYYY-MM-DD
facets	指定されたアクティビティコンテキストについて取得するアクティビティファセットの sys_id のカンマ区切りリスト。アクティビティコンテキストに定義されているアクティビティファセットタイプを表示するには、次に移動します顧客セントラル > 顧客アクティビティ > アクティビティコンテキスト関連リストを確認しますデータタイプ：文字列デフォルト：アクティビティコンテキストに構成されているすべてのアクティビティファセットを返します。
get_activity_count	応答本文に各ファセットのアクティビティカウントを含めるかどうかを示すフラグ。有効な値： true：ファセットのアクティビティカウントを含めます。 false：ファセットのアクティビティカウントを省略します。データタイプ：ブーリアンデフォルト値：false
lazy_load	パフォーマンスを向上させるために、応答本文からファセットのアクティビティデータとアクティビティカウントを省略するかどうかを示すフラグ。このパラメーターは get_activity_count よりも優先されます。有効な値： true：ファセットのアクティビティデータとアクティビティカウントを省略します。 false：ファセットのアクティビティデータとアクティビティカウントを取得します。データタイプ：ブーリアンデフォルト値：false
start_date	日付/時刻値。この要求は、このパラメーターと end_date で定義した期間中に作成されたレコードのみを返します。end_date とともに設定する必要があります。データタイプ：文字列形式：YYYY-MM-DD hh:mm:ss または YYYY-MM-DD

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

ヘッダー

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

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

ステータスコード

表 : 12. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。応答本文 result.message パラメーターは、エラーの性質を示します。エラーメッセージの例： `[有効なアクティビティコンテキストの詳細が渡されていることを確認してください]` は、activity_context パスパラメーター値が有効なアクティビティコンテキストを表していないか、context_instance パスパラメーター値が指定されたアクティビティコンテキストの有効なインスタンスを表していないか、またはその両方であることを示します。 `[start_date と end_date を入力してください]` は、要求に start_date と end_date のいずれかのクエリパラメーターしか含まれていないことを示します。これのパラメーターは別々に使用することはできません。 `[start_date を end_date より後にすることはできません]` は、指定された start_date クエリパラメーター値が、指定された end_date クエリパラメーター値の後に存在することを示します。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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


名前	説明
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_id のアレイ。アクティビティファセット [sn_actsub_facet] テーブルにあります。動的ファセットの場合、この配列にはファセット自体の sys_id が含まれます。静的ファセットの場合は、ファセットの子であるすべてのファセットの sys_id が代わりに含まれます。データタイプ：アレイ `"facets": [ "510d7e2e73570010e37d71ef64f6a70d", "bc9bfaaa73570010e37d71ef64f6a771" ]`
result.icon	このファセットに関連付けられたアイコンの名前。データタイプ：文字列
result.is_dynamic	このファセットが動的ファセットであるかどうかを示すフラグ。この値は、children 応答本文パラメーターに含まれる情報のタイプを決定します。有効な値： true：これは動的ファセットです。children 応答本文のパラメーター値にはアクティビティレコードの詳細が含まれ、facets パラメーターには動的ファセット sys_id が含まれます。 false：これは静的ファセット (ファセットグループ) です。children 応答本文のパラメーター値には子ファセットが含まれ、facets パラメーターにはこれらの子ファセットの sys_id が含まれます。データタイプ：ブーリアン
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"
        }
      ]
    }
  ]
}