Garoon APIドキュメント

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

目次

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

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

管理者権限でメッセージ本文もしくはコメント欄内の添付ファイル一覧を取得します。
次のメッセージ内のファイルも取得できます。

  • 管理者がメンバーではないプライベートメッセージ
  • 下書きメッセージ
  • 完全に削除されていないメッセージ

URL

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

クラウド版

https://sample.cybozu.com/g/api/v1/message/admin/MESSAGE_ID/files

パッケージ版

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

  • IP_ADDRESS_OR_HOST_NAME：Garoonのインストール先のIPアドレスまたはホスト名
  • INSTALL_IDENTIFER：Garoonのインストール識別子
Windows環境
http://IP_ADDRESS_OR_HOST_NAME/scripts/INSTALL_IDENTIFER/grn.exe/api/v1/message/admin/MESSAGE_ID/files
Linux環境
http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/grn.cgi/api/v1/message/admin/MESSAGE_ID/files
パスパラメーター
パラメーター名 説明
MESSAGE_ID メッセージのID

HTTPメソッド

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

GET

利用できるバージョン

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

  • クラウド版Garoon

必要なアクセス権

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

リクエスト

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

パラメーター

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

パラメーター名 型 必須 説明
offset 数値 省略可 取得するファイルの先頭からスキップする数
省略すると、0が設定されます。
limit 数値 省略可 取得するファイル数の上限
1から1,000まで指定できます。省略すると100が設定されます。
リクエストの例
URL

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

ヘッダー
1
2
3

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

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

レスポンス

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

プロパティ
プロパティ名 型 説明
files 配列（オブジェクト） メッセージの一覧
files[].id 文字列 ファイルのID
files[].name 文字列 ファイルの名前
files[].size 文字列 ファイルのサイズ
files[].creator[].id 文字列 作成者のGaroonユーザーID
files[].creator[].name 文字列 作成者の表示名
files[].creator[].code 文字列 作成者のログイン名
files[].updater[].id 文字列 更新者のGaroonユーザーID
files[].updater[].name 文字列 更新者の表示名
files[].updater[].code 文字列 更新者のログイン名
files[].createdAt 文字列 作成日時
files[].updatedAt 文字列 更新日時
hasNext 真偽値 次のファイルがあるかどうか
  • true：次のファイルがある
  • false：次のファイルがない
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

{
  "hasNext" : false
  "files" : [
    {
      "id": "2",
      "name": "Development_plan.pdf",
      "size": "31415",
      "creator": 
           {
                "id": "5",
                "name": "Sato Yuki",
                "code": "yuki-sato"
            },
      "updater": 
            {
                "id": "6",
                "name": "Suzuki Aoki",
                "code": "aoki-suzuki"
            },
      "createdAt": "2024-10-11T09:04:54Z",
      "updatedAt": "2024-11-29T08:50:22Z"
    },
    {
      "id": "10",
      "name": "Customers.csv",
      "size": "23456",
      "creator": 
            {
                "id": "7",
                "name": "Abe Kenta",
                "code": "kenta-abe"
            },
      "updater": 
            {
                "id": "6",
                "name": "Ito Nozomi",
                "code": "nozomi-ito"
            },
      "createdAt": "2024-10-11T09:04:54Z",
      "updatedAt": "2024-11-29T08:50:22Z"
    }
  ]
}

サンプルコード

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

curlを使ったリクエスト

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

1
2

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

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