Chatter REST API 開発者ガイド
jManaged Topics
コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユーザ) のみが、管理トピックの作成または並び替えを行うことができます。
- リソース
-
- 使用可能なバージョン
- 32.0
- Chatter が必要かどうか
- いいえ
- HTTP メソッド
- GET、POST、PATCH、HEAD
- GET の要求パラメータ
- すべての管理トピック階層を表示するには、次のように depth パラメータを 8 に、managedTopicType を Navigational に設定して GET 要求を行います。
パラメータ名 型 説明 必須項目/省略可能 使用可能なバージョン depth Integer 整数 1 ～ 8 を指定します。1 を指定すると、Managed Topic レスポンスボディの children プロパティは null になります。2 を指定すると、Managed Topic レスポンスボディの children プロパティには管理トピックの直接の子である管理トピック (存在する場合) が含まれます。3 ～ 8 を指定すると、直接の子である管理トピックとその子管理トピック (存在する場合) が取得されます。depth が指定されていない場合、デフォルトは 1 です。 省略可能 35.0 managedTopicType String 管理トピックの種別。 - Featured — コミュニティホームページなどの主要トピック。ただし、全体的なナビゲーションは提供しません。
- Navigational — コミュニティのナビゲーションメニューに表示されるトピック。
1 つのトピックは最大 2 つの種別の管理トピックに関連付けることができるため、1 つのトピックを Featured トピックと Navigational トピックの両方にすることができます。
省略可能 recordId または depth を指定する場合は必須
32.0 recordId String 管理トピックに関連付けられたトピックの ID。 バージョン 38.0 以降では、recordIds を使用します。
省略可能 35.0 ～ 37.0 recordIds List<String> 管理トピックに関連付けられた最大 100 件のトピック ID のリスト。 10 を超えるトピック ID を含める場合、depth に 2 ～ 8 は指定できません。
省略可能 38.0 - GET のレスポンスボディ
- Managed Topic Collection
- POST のリ���エストボディ
- POST 要求を実行し、管理トピックを作成してトピック階層を作成します。
-
- ルート XML タグ
- <managedTopic>
- recordId を使用する JSON の例
- この例では、既存の標準トピックから管理トピックを作成します (標準トピックの recordId を使用)。parentId によって親トピックを割り当て、トピック階層も作成します。
-
- name を使用する JSON の例
- この例では、名前で新しい管理トピックを作成し、parentId によって親トピックを割り当て、トピック階層を作成します。
-
- プロパティ
-
名前 型 説明 必須項目/省略可能 使用可能なバージョン managedTopicType String 管理トピックの種別。 - Featured — コミュニティホームページなどの主要トピック。ただし、全体的なナビゲーションは提供しません。
- Navigational — コミュニティのナビゲーションメニューに表示されるトピック。
1 つのトピックは最大 2 つの種別の管理トピックに関連付けることができるため、1 つのトピックを Featured トピックと Navigational トピックの両方にすることができます。
managedTopicType につき、最大 25 個の管理トピックを作成できます。
子管理トピックを作成するには、managedTopicType として Navigational を指定し、parentId を指定します。
必須項目 32.0 name String 管理トピックの名前。 新規トピックでは必須 name または recordId を指定する必要があります。両方を指定することはできません。
32.0 parentId String 親管理トピックの ID。 parentId を指定する場合は、managedTopicType として Navigational も指定します。
最大 8 レベル (親、直接の子、その子など) の管理トピックを作成でき、管理トピックにつき最大 10 個の子管理トピックを作成できます。
省略可能 35.0 recordId String 管理トピックになるレコードの ID。 バージョン 32.0 では、recordId はトピック ID である必要があります。
Name プロパティが使用されていない場合、既存のトピックに必要です。 name または recordId を指定する必要があります。両方を指定することはできません。
32.0
- POST の要求パラメータ
-
- POST のレスポンスボディ
- Managed Topic
- PATCH のリクエストボディ
- PATCH 要求を行い、親管理トピックまたは同じ親を持つ子管理トピックを並び替えます。
- ルート XML タグ
- <managedTopicPositionCollection>
- JSON の例
-
- プロパティ
-
名前 型 説明 必須項目/省略可能 使用可能なバージョン managedTopicPositions Managed Topic Position Input[] Managed Topic Position リクエストボディのコレクション。このコレクションには、Featured および Navigational 管理トピックを含めることができます。すべての管理トピックを含める必要はありません。 managedTopicPositions に含めない管理トピックがある場合、管理トピックは、managedTopicPositions で指定されている位置に従って並び替えられます。managedTopicPositions に含まれない管理トピックは、次に利用可能な位置まで押し下げられます。「管理トピックの並び替えの例」を参照してください。
必須項目 32.0 - 管理トピックの並び替えの例
-
次の管理トピックがあるとします。
管理トピック 位置 ManagedTopicA 0 ManagedTopicB 1 ManagedTopicC 2 ManagedTopicD 3 ManagedTopicE 4 Managed Topic Position Collection Input に次の情報を含めて管理トピックを並び替えます。
管理トピック 位置 ManagedTopicD 0 ManagedTopicE 2 結果は次のとおりです。
管理トピック 位置 ManagedTopicD 0 ManagedTopicA 1 ManagedTopicE 2 ManagedTopicB 3 ManagedTopicC 4
- PATCH のレスポンスボディ
- Managed Topic Collection