掲示板を作成する
掲示板を作成するAPIです。 このAPIは、作成する掲示板の情報をリクエストとして受け取り、作成した掲示板情報をレスポンスとして返します。掲示板の本文の書式は編集できません。
API名
BulletinCreateTopics
使用可能なGaroonのバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.1以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| create_topic | bulletin:BulletinCreateTopicType | 1~ 無制限 | 作成する掲示板の情報 |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| topic | bulletin:TopicType | 0~ 無制限 | 作成した掲示板の情報 |
例
|
|
エラー
| エラー番号 | 説明 |
|---|---|
| GRN_BLLT_16002 | 存在しないカテゴリIDを指定した場合 |
| GRN_BLLT_16073 | bulletin:TopicTypeの@manually_enter_senderに空文字列を指定した場合 |
| GRN_UTIL_API_65009 | アップロードするファイルのサイズが、BASE64エンコード後で300MBより大きい場合 |
下書きを保存する
掲示板の情報をリクエストで受け取り、下書きに保存するAPIです。このAPIは、書式編集を利用した下書き保存に対応していません。
API名
BulletinSaveDraftTopics
使用可能なGaroonのバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.1以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| save_draft_topic | bulletin:BulletinCreateTopicType | 1~ 無制限 | 作成する掲示板の下書きの情報 |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| topic | bulletin:TopicType | 0~ 無制限 | 作成した掲示板の下書きの情報 |
例
|
|
エラー
| エラー番号 | 説明 |
|---|---|
| GRN_BLLT_16006 | 開始日時が終了日時より後の場合 |
| GRN_BLLT_16069 | 標題がない場合 |
| GRN_BLLT_16073 | bulletin:TopicTypeの@manually_enter_senderに空文字列を指定した場合 |
| GRN_UTIL_API_65009 | アップロードするファイルのサイズが、BASE64エンコード後で300MBより大きい場合 |
掲示板を更新する
掲示板を更新するAPIです。このAPIは、書式編集を利用した掲示板の更新に対応していません。
API名
BulletinModifyTopics
使用可能なGaroonのバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.1以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| modify_topic | bulletin:BulletinModifyTopicType | 1~ 無制限 | 更新する掲示板の下書きの情報 |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| topic | bulletin:TopicType | 0~ 無制限 | 更新された掲示板の下書きの情報 |
例
|
|
エラー
| エラー番号 | 説明 |
|---|---|
| GRN_BLLT_16003 | 指定した掲示板が存在しない場合 |
| GRN_BLLT_16006 | 開始日時が終了日時より後の場合 |
| GRN_BLLT_16073 | bulletin:TopicTypeの@manually_enter_senderに空文字列を指定した場合 |
| GRN_UTIL_API_65009 | アップロードするファイルのサイズが、BASE64エンコード後で300MBより大きい場合 |
掲示板を削除する
掲示板のIDをもとに掲示板を削除するAPIです。
API名
BulletinRemoveTopics
使用可能なGaroonのバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.1以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| @topic_id | base:IDType | 1 | 削除する掲示板のID |
| @is_draft | xsd:boolean | 1 |
|
例
|
|
レスポンス
なし
エラー
| エラー番号 | 説明 |
|---|---|
| GRN_BLLT_16003 | 指定した掲示板が存在しない場合 |
| GRN_BLLT_16005 | 指定した掲示板の下書きが存在しない場合 |
