Data Category Groups

構文

適用開始バージョン

38.0

メソッド

GET

形式

JSON、XML

認証

OAuth accesstoken

エンドポイント

[prefix]/support/dataCategoryGroups

HTTP ヘッダー

Accept: 省略可能。application/json または application/xml のいずれかです。

Accept-language: 省略可能。カテゴリを翻訳する言語。HTTP Accept-Language ヘッダーのいずれかの ISO-639 言語の略語および ISO-3166 国コードサブタグ。指定できる言語は 1 つのみです。原語が指定されない場合、翻訳されていない表示ラベルが返されます。

入力:

string sObjectName: 必須。KnowledgeArticleVersion のみ。

boolean topCategoriesOnly: 省略可能。デフォルトは true です。

• true の場合、最上位カテゴリのみを返します。
• false の場合、ツリー全体を返します。

すべての入力パラメータで大文字と小文字が区別されます。

メモ

出力:

サイトのコンテキストで現在のユーザが参照可能で有効なデータカテゴリグループのリスト。ID、名前、表示ラベル、および現在のユーザが参照可能な最上位カテゴリまたはデータカテゴリグループツリー全体を返します。指定された言語がある場合、表示ラベルはその言語に翻訳されている必要があります。

• Data Category Group List

  このペイロードは、他の要求でデータカテゴリとそれに関連する記事を返すために使用できる有効なルートデータカテゴリグループのリストです。

  1{
  2    "categoryGroups": [ Data Category Group, ....],
  3}

  指定されたエンティティ (sObjectName によって指定) に関連する有効なグループのみを返します。KnowledgeArticleVersion のみがサポートされています。

  メモ

• Data Category Group

  個々のデータカテゴリグループとそのルートカテゴリを表します。

  1{
  2    "name": String,  // the unique name of the category group
  3    "label": String,  // returns the translated version if it is available
  4    "objectUsage" : String, // currently only "KnowledgeArticleVersion" is available.
  5    "topCategories": [ Data Category Summary, ....]
  6}

• Data Category Summary

  データカテゴリ情報の概要を提供します。Summary 応答と Detail 応答のプロパティは共通です。これは、関連するリソースから必要な情報のみを提供するためです。

  1{
  2    "name": String, // the unique name of the category
  3    "label":  String,  // returns the translated version if it is available
  4    "url":  URL,    // the url points to the data category detail API
  5	"childCategories": [ Data Category Summary, ....] // null if topCategoriesOnly is true
  6}

  URL プロパティは、このデータカテゴリを表す一意のリソース (この場合は Data Category Detail API) への事前計算されたパスです。

  メモ

例

入力

1/services/data/v38.0/support/dataCategoryGroups?sObjectName=KnowledgeArticleVersion

出力

1{
2  "categoryGroups" : [ {
3	"label" : "Doc",
4	"name" : "Doc",
5	"objectUsage" : "KnowledgeArticleVersion",
6	"topCategories" : [ {
7  	"childCategories" : null,
8  	"label" : "All",
9  	"name" : "All",
10  	"url" : "/services/data/v38.0/support/dataCategoryGroups/Doc/dataCategories/All?sObjectName=KnowledgeArticleVersion"
11	} ]
12  }, {
13	"label" : "Manual",
14	"name" : "Manual",
15	"objectUsage" : "KnowledgeArticleVersion",
16	"topCategories" : [ {
17  	"childCategories" : null,
18  	"label" : "All",
19  	"name" : "All",
20  	"url" : "/services/data/v38.0/support/dataCategoryGroups/Manual/dataCategories/All?sObjectName=KnowledgeArticleVersion"
21	} ]
22  } ]
23}

使用方法

Salesforce ナレッジが組織で有効になっている必要があります。このリソースは API バージョン 38.0 以降で使用できます。「Salesforce がサポートする言語は?」で使用されている言語コード形式を使用してください。

ユーザが参照可能なデータカテゴリのみが返されます。ユーザはカテゴリグループ内のいくつかのサブツリーを参照できる場合があるため、各グループ内でユーザが参照可能な最上位カテゴリが返されます。