Garoon APIドキュメント

ファイルを取得する

目次

ファイルをダウンロードする

固定リンクがコピーされました

ファイルIDをリクエストとして受け取り、ファイルをレスポンスとして返すAPIです。

API名

固定リンクがコピーされました

WorkflowFileDownload

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@file_id base:IDType 1 ファイルID
例
1

<parameters file_id="3"></parameters>

レスポンス

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
file base:FileBodyType 1 ファイル内容（Base64形式）
例
1
2
3
4
5

<returns> 
  <file> 
    <content>dGVzdA==</content> 
  </file> 
</returns>

エラー

固定リンクがコピーされました

エラー番号 説明
GRN_WRKF_25322 指定したファイルが存在しない場合

ファイルの詳細情報を取得する

固定リンクがコピーされました

フォームのIDとファイルのIDをリクエストとして受け取り、受け取った条件に当てはまるファイルを検索して、そのファイルの詳細情報を返すAPIです。APIを実行するユーザーにシステム管理権限が必要です。

API名

固定リンクがコピーされました

WorkflowGetAttachedFileBody

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.1以降

リクエスト

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
parameter workflow:WorkflowGetAttachedFileBodyType 1～ 無制限 取得するファイルの情報
例
1
2
3

<parameters>
  <parameter xmlns="" request_form_id="4" file_id="1"></parameter>
</parameters>

レスポンス

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
attachment_detils workflow:FileAttachedDetail 1～ 無制限 ファイルの詳細情報
例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

<returns> 
  <attachment_details> 
    <file_header 
     file_id="1" 
     request_form_id="4" 
     name="11.diff" 
     size="820 bytes"> 
    </file_header> 
    <file_information 
     subject="" 
     versioning="0" 
     create_time="1295921137" 
     modify_time="1295921137" 
     description=""> 
    </file_information> 
  </attachment_details> 
</returns>

エラー

固定リンクがコピーされました

エラー番号 説明
GRN_WRKF_25322 指定したファイルが存在しない場合
GRN_CMMN_00005 API実行ユーザーにシステム管理権限がない場合