Garoon APIドキュメント

メッセージの添付ファイルを取得する

目次

メッセージの添付ファイルを取得する

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

管理者権限で、メッセージに添付されたファイルの情報を取得します。

URL

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

クラウド版

https://sample.cybozu.com/g/api/v1/message/admin/messages/attached/FILE_Id

パスパラメーター
パラメーター名 説明
FILE_Id ファイルのID
以下のAPIを利用して取得できます。
メッセージの添付ファイル一覧を取得する

HTTPメソッド

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

GET

利用できるバージョン

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

  • クラウド版Garoon

必要なアクセス権

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

リクエスト

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

パラメーター

リクエストパラメーターは、URLクエリパラメーターとして送信してください。
ただし、 Garoon REST APIリクエストを送信するAPI を使って実行する場合は、リクエストボディとして指定できます。

パラメーター名 型 必須 説明
id 数値 省略不可 ファイルのID
リクエストの例
URL

https://sample.cybozu.com/g/api/v1/message/admin/messages/attached/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": "1",
    "contentType": "text/csv",
    "name": "User_list.csv",
    "size": "1010",
    "content": "dXNlcjEKdXNlcjI="
}

サンプルコード

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

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行 

1
2

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

await garoon.api('/api/v1/message/admin/messages/attached/1', 'GET', {});