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

フォローする

Index

TopicListType

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

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.1.0以降

データ構造

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

TopicType

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

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.1.0以降

データ構造

パラメーター名 パラメーター数 説明 変更履歴
@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:差出人名が直接入力されている
直接入力された差出人の名前 Garoon on cybozu.com で追加
@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
  • true:未読
  • false:既読
 
@expired xsd:boolean 0 ~ 1 掲示期間
  • true:過ぎている
  • false:過ぎていない
 
@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 1 書き込んだユーザー  
modifier base:ChangeLogType 1 変更したユーザー  

CategoryInformationType

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

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.1.0以降

データ構造

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

CategoryType

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

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.1.0以降

データ構造

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

CategoriesType

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

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.1.0以降

データ構造

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

FollowType

コメントを表す型です。

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.1.0以降

データ構造

パラメーター名 パラメーター数 説明
@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 on cybozu
  • パッケージ版 バージョン 3.1.0以降

データ構造

パラメーター名 パラメーター数 説明
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 on cybozu
  • パッケージ版 バージョン 3.1.0以降

データ構造

パラメーター名 パラメーター数 説明
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と同じ

BulletinAddFollowType

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

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.1.0以降

データ構造

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

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。
Powered by Zendesk