Garoon APIドキュメント

掲示板APIで使用するデータの構造

目次

TopicListType

固定リンクがコピーされました

カテゴリ内の掲示板一覧を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.1以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
topic - 0～ 無制限 掲示板一覧
topic/@id base:IDType 1 掲示板ID
@category_id base:IDType 1 カテゴリID

TopicType

固定リンクがコピーされました

掲示板の詳細情報を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.1以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明 変更履歴
@id base:IDType 1 掲示板のID
@creator_group_id base:IDType 0～1 組織ID（差出人項目の設定で「組織名を表示」にチェックを入れた場合）
@version base:VersionType 1 掲示板のバージョン情報
@subject xsd:string 1 標題
@manually_enter_sender xsd:string 0～1
  • 0:差出人は書き込んだユーザー
  • 1:差出人名が直接入力されている
 直接入力された差出人の名前 パッケージバージョン4.6.0で追加
@is_draft xsd:boolean 0～1
  • true：下書き
  • false：下書きでない
@start_datetime xsd:dateTime 0～1 掲示期間の開始日時
@end_datetime xsd:dateTime 0～1 掲示期間の終了日時
@start_is_datetime xsd:boolean 0～1 掲示期間の開始日時の設定
  • true：有り
  • false：なし、または日付のみを設定した場合
@end_is_datetime xsd:boolean 0～1 掲示期間の終了日時の設定
  • true：有り
  • false：なし、または日付のみを設定した場合
@can_follow xsd:boolean 1 コメントの許可
  • true：有り
  • false：なし
@published xsd:boolean 0～1 掲示板の公開
  • true：されている
  • false：されていない
@unread xsd:boolean 0～1 APIを実行したユーザーの掲示板の閲覧状態
  • true：未読
  • false：既読
@expired xsd:boolean 0～1 掲示期間
  • true：過ぎている
  • ffalse：過ぎていない
@category_id base:IDType 1 カテゴリID
content - 1 掲示内容
content/@body xsd:string 1 本文
content/@html_body xsd:string 0～1 本文（リッチテキスト）
content/file - 0～ 無制限 添付ファイル
content/file/@id base:IDType 1 ファイルID
content/file/@name base:NonBlankStringType 1 ファイル名
content/file/@size xsd:unsignedLong 0～1 ファイルサイズ
content/file/@mime_type xsd:string 0～1 MIMEタイプ
follow - 0～1 コメント
follow/@id base:IDType 1 コメントID
follow/@number base:NonBlankStringType 1 コメント番号
creator base:ChangeLogType 0～1 書き込んだユーザー
modifier base:ChangeLogType 0～1 変更したユーザー

CategoryInformationType

固定リンクがコピーされました

カテゴリ情報を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.1以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
root bulletin:CategoryType 1 ルートカテゴリ

CategoryType

固定リンクがコピーされました

掲示板のカテゴリ情報を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.1以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
name xsd:string 1 カテゴリの名前
description xsd:string 1 カテゴリの説明
creator_id xsd:string 1 作成者のGaroonユーザーID
creator_login_name xsd:string 1 作成者のログイン名
creator_display_name xsd:string 1 作成者のアカウント名
create_time xsd:date 1 作成日
mdifier_id xsd:string 1 更新者のGaroonユーザーID
modifier_login_name xsd:string 1 更新者のログイン名
modifier_display_name xsd:string 1 更新者のアカウント名
modify_time xsd:date 1 更新日
categories bulletin:CategoryType 0～1 子カテゴリ
@id base:IDType 1 カテゴリID
@code xsd:string 1 カテゴリコード
@list_index xsd:unsignedInt 1 カテゴリの表示順序

CategoriesType

固定リンクがコピーされました

カテゴリ内の子カテゴリ一覧を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.1以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@parent_id base:IDType 1 親カテゴリのID
@parent_code xsd:string 1 親カテゴリコード
category bulletin:CategoryType 0～ 無制限 カテゴリ一覧

FollowType

固定リンクがコピーされました

コメントを表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.1以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@id base:IDType 1 コメントID
@number base:NonBlankStringType 1 コメント番号
@text xsd:string 1 本文
@html_text xsd:string 0～1 本文（リッチテキスト）
file - 0～1 添付ファイル
file/@id base:IDType 1 ファイルID
file/@name base:NonBlankStringType 1 ファイル名
file/@size xsd:unsignedLong 0～1 ファイルサイズ
file/@mime_type xsd:string 0～1 MIMEタイプ

BulletinCreateTopicType

固定リンクがコピーされました

掲示板の作成を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.1以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
topic bulletin:TopicType 1 掲示板一覧
file - 0～ 無制限 添付ファイル
file/content xsd:base64Binary 1 ファイル内容
file/@id base:IDType 1 ファイルID
remove_file_id base:IDType 0～ 無制限 削除する添付ファイルのファイルID
＠draft_id base:IDType 0～1 掲示板の下書きのID

BulletinModifyTopicType

固定リンクがコピーされました

掲示板の変更を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.1以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明 変更履歴
topic bulletin:TopicType 1 掲示板一覧
file - 0～ 無制限 添付ファイル
file/content xsd:base64Binary 1 ファイル内容
file/@id base:IDType 1 ファイルID
remove_file_id base:IDType 0～ 無制限 削除する添付ファイルのファイルID
@is_notified xsd:boolean 0〜1 - true: 更新通知をする
- false: 更新通知をしない
- 指定なし: trueと同じ		 パッケージバージョン4.6.0で追加

BulletinAddFollowType

固定リンクがコピーされました

コメントの追加を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.1以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
follow bulletin:FollowType 1 コメント
file - 0～ 無制限 添付ファイル
file/content xsd:base64Binary 1 ファイル内容
file/@id base:IDType 1 ファイルID
@topic_id base:IDType 1 掲示板ID