Garoon API ドキュメント

申請データに添付されたファイルを取得する

目次

申請データに添付されたファイルを取得する

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

申請データに添付されたファイルを取得します。

URL

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

クラウド版

https://sample.cybozu.com/g/api/v1/workflow/admin/files/FILE_ID

パッケージ版

環境に合わせてそれぞれ以下を置き換えてください。

  • IP_ADDRESS_OR_HOST_NAME：Garoon のインストール先の IP アドレスまたはホスト名
  • INSTALL_IDENTIFER：Garoon のインストール識別子
Windows 環境
http://IP_ADDRESS_OR_HOST_NAME/scripts/INSTALL_IDENTIFER/grn.exe/api/v1/workflow/admin/files/FILE_ID
Linux 環境
http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/grn.cgi/api/v1/workflow/admin/files/FILE_ID
パスパラメーター
パラメーター名 説明
FILE_ID 取得するファイルのファイル ID

HTTP メソッド

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

GET

利用できるバージョン

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

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

必要なアクセス権

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

  • ワークフローのアプリケーション管理者

リクエスト

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

パラメーター

なし

リクエストの例
URL

https://sample.cybozu.com/g/api/v1/workflow/admin/files/1

ヘッダー
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は Garoon REST API の共通仕様 を参照してください。

レスポンス

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

プロパティ
プロパティ名 型 説明
id 文字列 ファイル ID
contentType 文字列 ファイルのコンテンツタイプ
name 文字列 ファイル名
size 文字列 ファイルサイズ（バイト）
content 文字列 ファイルの内容を Base64 エンコードした値
レスポンスの例
1
2
3
4
5
6
7

{
  "id": "10",
  "contentType": "text/plain",
  "name": "testFile1.txt",
  "size": "23175",
  "content": "dGVzdA=="
}

サンプルコード

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

curl を使ったリクエスト
1
2

curl -X GET 'https://sample.cybozu.com/g/api/v1/workflow/admin/files/1' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
Garoon REST API リクエストを送信する API を使ったリクエスト
1

await garoon.api('/api/v1/workflow/admin/files/1', 'GET', {});