マルチレポートAPIで使用するデータの構造
固定リンクがコピーされました
ReportType
固定リンクがコピーされました
1つのレポートを表す型です。
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 | 変更履歴 |
|---|---|---|---|---|
| @id | base:IDType | 1 | レポートID | |
| @subject | xsd:string | 1 | レポートのタイトル | |
| @is_draft | xsd:boolean | 0～1 | - true:下書き - false:下書きでない |
|
| items | - | 1 | 項目一覧 | |
| items/item | report:ItemType | 0～ 無制限 | 通常の項目 | |
| items/files_item | report:FilesItemType | 0～ 無制限 | ファイル添付項目 | |
| items/blank_item | - | 0～ 無制限 | 空行 | |
| members | - | 1 | 参加者一覧 | |
| members/user | report:UserType | 0～ 無制限 | 参加者 | |
| notifyusers | - | 1 | 通知先一覧 | |
| notifyusers/user | report:UserType | 0～ 無制限 | 通知先 | |
| maintainers | - | 1 | レポートを変更できるユーザー一覧 | パッケージバージョン3.1.0で追加 |
| maintainers/user | report:UserType | 0～ 無制限 | レポートを変更できるユーザー | パッケージバージョン3.1.0で追加 |
| creator | base:ChangeLogType | 1 | レポートの作成者 | |
| modifier | base:ChangeLogType | 1 | レポートの更新者 |
UserType
固定リンクがコピーされました
ユーザーを表す型です。
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| @id | base:NonBlankStringType | 1 | GaroonユーザーID |
| @name | xsd:string | 1 | ユーザー名 |
ItemType
固定リンクがコピーされました
フォーム内の1つの項目を表す型です。
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| @name | base:NonBlankStringType | 1 | 項目名 |
| @value | xsd:string | 1 | 値 |
| @front | xsd:string | 0～1 | 値の前に付く文字列 |
| @back | xsd:string | 0～1 | 値の後ろに付く文字列 |
FilesItemType
固定リンクがコピーされました
添付ファイルの項目を表す型です。
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| @name | base:NonBlankStringType | 1 | 項目名 |
| @inline | xsd:boolean | 0～1 | インラインの表示
|
| file | - | 0～ 無制限 | 添付ファイル一覧 |
| file/@name | base:NonBlankStringType | 1 | ファイル名 |
| file/@file_id | base:IDType | 1 | ファイルID |
| file/@sizse | xsd:unsignedLong | 0～1 | ファイルサイズ |
| file/@mime_type | xsd:string | 0～1 | MIMEタイプ |
FollowType
固定リンクがコピーされました
レポートに書き込まれたコメントを表す型です。
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| @id | base:IDType | 1 | コメントID |
| @number | base:NonBlankStringType | 1 | コメント番号 |
| @text | xsd:string | 1 | 本文 |
| @html_text | xsd:string | 0～1 | HTMLテキスト |
| creator | base:ChangeLogType | 1 | コメント作成者 |
| file | - | 0～ 無制限 | 添付ファイル一覧 |
| file/@name | base:NonBlankStringType | 1 | ファイル名 |
| file/@file_id | base:IDType | 1 | ファイルID |
| file/@sizse | xsd:unsignedLong | 0～1 | ファイルサイズ |
| file/@mime_type | xsd:string | 0～1 | MIMEタイプ |
SearchTargetType
固定リンクがコピーされました
検索対象を表す型です。
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。
| 値 | 説明 |
|---|---|
| received | 受信一覧 |
| send | 送信一覧 |
| draft | 下書き |
| all | 閲覧可能なレポート |
ReportAddFollowType
固定リンクがコピーされました
コメントを追加する際に使用する型です。
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| @report_id | base:IDType | 1 | レポートID |
| follow | report:FollowType | 1 | コメント |
| file | - | 0～ 無制限 | 添付ファイル一覧 |
| file/@id | base:IDType | 1 | ファイルID |
| file/content/text() | xsd:base64Binary | 1 | ファイルの内容 |