ファイル管理APIで使用するデータの構造
固定リンクがコピーされました
FolderInformationType
固定リンクがコピーされました
ルートフォルダーをもと点とするフォルダー一覧の情報を表す型です。
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| root | cabinet:FolderType | 1 | ルートフォルダー |
FolderType
固定リンクがコピーされました
フォルダーを表す型です。
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| @id | base:IDType | 1 | フォルダーID |
| @code | xsd:string | 1 | フォルダーコード |
| @list_index | xsd:unsignedInt | 1 | 表示順序 |
| @title/text() | xsd:string | 1 | フォルダー名 |
| description/text() | xsd:string | 1 | メモ |
| creator_id/text() | xsd:string | 1 | 作成者のGaroonユーザーID |
| creator_login_name/text() | xsd:string | 1 | 作成者のログイン名 |
| creator_display_name/text() | xsd:string | 1 | 作成者のアカウント名 |
| create_time/text() | xsd:dateTime | 1 | 作成日時 |
| modifier_id/text() | xsd:string | 1 | 更新者のGaroonユーザーID |
| modifier_login_name/text() | xsd:string | 1 | 更新者のログイン名 |
| modifier_display_name/text() | xsd:string | 1 | 更新者のアカウント名 |
| modify_time/text() | xsd:dateTime | 1 | 更新日時 |
| folders | cabinet:FoldersType | 0～1 | 子フォルダー一覧 |
FoldersType
固定リンクがコピーされました
フォルダー一覧を表す型です。
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| @parent_id | base:IDType | 1 | 親フォルダーID |
| @parent_code | xsd:string | 1 | 親フォルダーコード |
| folder | cabinet:FolderType | 0～ 無制限 | 子フォルダー一覧 |
SimpleFileInformationType
固定リンクがコピーされました
ファイル情報を表す型です。
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| title | xsd:string | 1 | ファイル名 |
| max_version | xsd:integer | 1 | バージョン管理する世代数
|
| name | xsd:string | 1 | ファイルのタイトル |
| size | xsd:unsignedInt | 1 | ファイルサイズ |
| mime_type | xsd:string | 1 | MIMEタイプ |
| description | xsd:string | 0～1 | 説明 |
| creator_id | base:IDType | 1 | 作成者のGaroonユーザーID |
| creator_login_name | xsd:string | 1 | 作成者のログイン名 |
| creator_display_name | xsd:string | 1 | 作成者のアカウント名 |
| create_time | xsd:dateTime | 1 | 作成日時 |
| modifier_id | base:IDType | 0～1 | 更新者のGaroonユーザーID |
| modifier_login_name | xsd:string | 0～1 | 更新者のログイン名 |
| modifier_display_name | xsd:string | 0～1 | 更新者のアカウント名 |
| modify_time | xsd:dateTime | 0～1 | 更新日時 |
FileInformationType
固定リンクがコピーされました
ファイル情報を表す型です。
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| files | cabinet:FilesType | 1 | ファイルの一覧情報 |
SimpleFileType
固定リンクがコピーされました
1つのファイルを表す型です。
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| @id | base:IDType | 1 | ファイルID |
| @folder_id | base:IDType | 1 | フォルダーID |
| title/text() | xsd:string | 1 | ファイル名 |
| max_version/text() | xsd:integer | 1 | バージョン管理する世代数
|
| name/text() | xsd:string | 1 | タイトル |
| size/text() | xsd:unsignedInt | 1 | ファイルサイズ |
| mime_type/text() | xsd:string | 1 | MIMEタイプ |
| description/text() | xsd:string | 0～1 | 説明 |
| creator_id/text() | base:IDType | 1 | 作成者のGaroonユーザーID |
| creator_login_name/text() | xsd:string | 1 | 作成者のログイン名 |
| creator_display_name/text() | xsd:string | 1 | 作成者のアカウント名 |
| create_time/text() | xsd:dateTime | 1 | 作成日時 |
| modifier_id/text() | base:IDType | 0～1 | 更新者のGaroonユーザーID |
| modifier_login_name/text() | xsd:string | 0～1 | 更新者のログイン名 |
| modifier_display_name/text() | xsd:string | 0～1 | 更新者のアカウント名 |
| modify_time/text() | xsd:dateTime | 0～1 | 更新日時 |
FileType
固定リンクがコピーされました
1つのファイルを表す型です。SimpleFileTypeと異なる点は、この型が更新履歴も含む点です。
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| @id | base:IDType | 1 | ファイルID |
| @folder_id | base:IDType | 1 | フォルダーID |
| title/text() | xsd:string | 1 | ファイル名 |
| max_version/text() | xsd:integer | 1 | バージョン管理する世代数
|
| name/text() | xsd:string | 1 | タイトル |
| size/text() | xsd:unsignedInt | 1 | ファイルサイズ |
| mime_type/text() | xsd:string | 1 | MIMEタイプ |
| description/text() | xsd:string | 0～1 | 説明 |
| creator_id/text() | base:IDType | 1 | 作成者のGaroonユーザーID |
| creator_login_name/text() | xsd:string | 1 | 作成者のログイン名 |
| creator_display_name/text() | xsd:string | 1 | 作成者のアカウント名 |
| create_time/text() | xsd:dateTime | 1 | 作成日時 |
| modifier_id/text() | base:IDType | 0～1 | 更新者のGaroonユーザーID |
| modifier_login_name/text() | xsd:string | 0～1 | 更新者のログイン名 |
| modifier_display_name/text() | xsd:string | 0～1 | 更新者のアカウント名 |
| modify_time/text() | xsd:dateTime | 0～1 | 更新日時 |
| histories | - | 1 | 更新履歴一覧 |
| histories/history | cabinet:HistoryType | 1～ 無制限 | 更新履歴 |
FilesType
固定リンクがコピーされました
ファイル一覧を表す型です。
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| @parent_id | base:IDType | 1 | 親フォルダーID |
| @parent_code | xsd:string | 1 | 親フォルダーコード |
| file | cabinet:FileType | 0～ 無制限 | ファイル一覧 |
HistoryType
固定リンクがコピーされました
更新履歴を表す型です。
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| version/text() | xsd:unsignedInt | 1 | バージョン |
| active/text() | xsd:unsignedInt | 1 | ファイルが存在
|
| name/text() | xsd:string | 1 | ファイル名 |
| action/text() | xsd:unsignedInt | 1 | ファイルへ行った操作
|
| comment/text() | xsd:string | 1 | コメント |
| modifier_id/text() | base:IDType | 1 | 更新者のGaroonユーザーID |
| modifier_login_name/text() | xsd:string | 1 | 更新者のログイン名 |
| modifier_display_name/text() | xsd:string | 1 | 更新者のアカウント名 |
| modiry_time/text() | xsd:dateTime | 1 | 更新日時 |