スペースの添付ファイルを取得する

目次

スペースの添付ファイルを取得する

システム管理者権限およびスペースのアプリケーション管理者権限で、スペースの添付ファイルの情報を取得できます。

URL

クラウド版

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

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

HTTPメソッド

GET

利用できるバージョン

  • クラウド版Garoon

必要なアクセス権

リクエスト

パラメーター

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

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

https://sample.cybozu.com/g/api/v1/space/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を使ったリクエスト

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

1
2
curl -X GET 'https\://sample.cybozu.com/g/api/v1/space/admin/files/1' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
Garoon REST APIリクエストを送信するAPI を使ったリクエスト
1
await garoon.api('/api/v1/space/admin/files/1', 'GET', {});