ファイルを追加する
追加するファイルの情報をリクエストのパラメーターとして受け取り、追加処理を実行後、追加したファイルの情報をレスポンスとして返す API です。
API名
CabinetAddFile
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
@hid | base:IDType | 1 | フォルダID |
@name | xsd:string | 1 | ファイル名 |
@title | xsd:string | 0 ~ 1 | タイトル |
@version | base:IDType | 0 ~ 1 | 管理する世代数 |
@description | xsd:string | 0 ~ 1 | 説明 |
content/text() | xsd:base64Binary | 1 | Base64でエンコードされたファイルデータ |
例
<parameters hid="4" name="file.txt" title="file" description="description"> <content xmlns=""> FFQVBJgsyQ3Yx2gsyRUIK1iKuCtYKqi2OYX4KzguqCxIKigsiFC </content> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
file | cabinet:SimpleFileType | 1 | ファイルの情報 |
例
<returns xmlns=""> <file id="3" folder_id="4"> <title>file</title> <max_version>0</max_version> <name>file.txt</name> <size>2205</size> <mime_type>text/plain</mime_type> <creator_id>1</creator_id> <creator_login_name>Administrator</creator_login_name> <creator_display_name>Administrator</creator_display_name> <create_time>1283220783</create_time> <description>description</description> </file> </returns>
エラー
エラー番号 | 説明 |
GRN_UTIL_API_65009 | アップロードするファイルのサイズが、BASE64エンコード後で300MBより大きい場合 |
ファイルを更新する
ファイルを更新する API です。
API名
CabinetUpdateFile
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.1.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
@file_id | base:IDType | 1 | ファイルID |
@name | xsd:string | 1 | ファイル名 |
@comment | xsd:string | 0 ~ 1 | コメント |
content | xsd:base64Binary | 1 | Base64でエンコードされたファイルデータ |
例
<parameters file_id="2" name="test.txt" comment="comment"> <content xmlns="">12345</content> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
file | cabinet:SimpleFileInformationType | 1 | 更新したファイル情報 |
例
<returns> <file id="2" folder_id="2" xmlns:cab="http://schemas.cybozu.co.jp/cabinet/2008"> <cab:title>2</cab:title> <cab:max_version>0</cab:max_version> <cab:name>test.txt</cab:name> <cab:size>3</cab:size> <cab:mime_type>text/plain</cab:mime_type> <cab:creator_id>1</cab:creator_id> <cab:creator_login_name>Administrator</cab:creator_login_name> <cab:creator_display_name>Administrator</cab:creator_display_name> <cab:create_time>2011-05-23T07:58:09Z</cab:create_time> <cab:modifier_id>1</cab:modifier_id> <cab:modifier_login_name>Administrator</cab:modifier_login_name> <cab:modifier_display_name>Administrator</cab:modifier_display_name> <cab:modify_time>2011-05-23T08:14:51Z</cab:modify_time> <cab:description></cab:description> </file> </returns>
エラー
エラー番号 | 説明 |
GRN_CBNT_17004 | 指定したファイルが存在しない場合 |
GRN_CBNT_17009 | フォルダにファイルを追加する権限が存在しない場合 |
GRN_CMMN_00202 | 指定したファイルを他の他のユーザーが操作中の場合 |
GRN_UTIL_API_65009 | アップロードするファイルのサイズが、BASE64エンコード後で300MBより大きい場合 |
ファイル情報を更新する
ファイルの管理情報を更新するAPIです。
API名
CabinetUpdateFileInformation
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.1.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
@file_id | base:IDType | 1 | ファイルID |
@title | xsd:string | 0 ~ 1 | タイトル |
@version | base:IDType | 0 ~ 1 | バージョン管理の世代数 |
@description | xsd:string | 0 ~ 1 | ファイルの説明 |
例
<parameters file_id=”2” title=”updated title” version=”10” description=”updated desc”> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
file | cabinet:SimpleFileInformationType | 1 | 更新したファイル情報 |
例
<returns> <file id=”2” folder_id=”2” xmlns:cab=”http://schemas.cybozu.co.jp/cabinet/2008”> <cab:title>updated title</cab:title> <cab:max_version>10</cab:max_version> <cab:name>test.txt</cab:name> <cab:size>3</cab:size> <cab:mime_type>text/plain</cab:mime_type> <cab:creator_id>1</cab:creator_id> <cab:creator_login_name>Administrator</cab:creator_login_name> <cab:creator_display_name>Administrator</cab:creator_display_name> <cab:create_time>2011-05-23T07:58:09Z</cab:create_time> <cab:modifier_id>1</cab:modifier_id> <cab:modifier_login_name>Administrator</cab:modifier_login_name> <cab:modifier_display_name>Administrator</cab:modifier_display_name> <cab:modify_time>2011-05-23T08:16:36Z</cab:modify_time> <cab:description>updated desc</cab:description> </file> </return>
エラー
エラー番号 | 説明 |
GRN_CBNT_17004 | 指定したファイルが存在しない場合 |
GRN_CBNT_17009 | ファイルを更新する権限が存在しない場合 |
ファイルを削除する
ファイルを削除するAPIです。
API名
CabinetDeleteFiles
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.1.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
file_id/text() | base:IDType | 1 | 削除するファイルのID |
例
<parameters> <file_id xmlns="">2</file_id> </parameters>
レスポンス
なし
エラー
エラー番号 | 説明 |
GRN_CBNT_17004 | 指定したファイルが存在しない場合 |
GRN_CBNT_17008 | 指定したファイルが存在するフォルダに閲覧権限がない場合 |
GRN_CBNT_17024 | 指定したファイルに対する削除権限がない場合 |
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。