このページを共有
GET: 添付ファイルを読む
このトピックでは、GET操作を使用して添付ファイルを読み取る手順について説明します。
概要
添付ファイルインスタンスには、エンティティデータとバイナリデータの両方があります。添付ファイルインスタンスのプロパティは、JSON形式のデータで表されます。
添付ファイルインスタンスは、添付ファイルコレクションのメンバーです。添付ファイルを参照してください。
添付ファイルエンティティの添付ファイルリソースを取得するには、添付ファイルエンティティIDが追加された添付ファイルコレクションのURIを使用します。
ヒント: エンティティIDを取得するには、最初にすべてのインスタンスを読み取り、目的のエンティティを見つけます。
例: GET /shared_spaces/<space_id>/workspaces/<workspace_id>/attachments/50、ここで50はアタッチメントIDです。
GETは、次の2つのコンテンツタイプをサポートします。
-
application/json添付ファイルのエンティティデータのみを取得するには
-
application/octet-stream添付ファイルのバイナリコンテンツのみを取得するには
注: インスタンスを取得する場合、RESTAPIは必ずしもインスタンスのすべてのフィールドを表示するわけではありません。使用可能なフィールドの完全なリストについては、メタデータの取得を参照してください。
例
添付エンティティインスタンスの取得例添付ファイルに対するこのGETリクエストは、添付ファイルのバイナリコンテンツを含まず、添付ファイルのエンティティデータのみを返します。
GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/attachments
{"total_count": 2,
"data": [
{
"type": "attachment",
"creation_time": "2016-10-27T12:20:59Z",
"version_stamp": 1,
"author": {
"type": "workspace_user",
"full_name": "MyAPIAccess",
"name": "MyAPIAccess_rnj70jxlvk6d3sqn2n227y6xk",
"id": "1003"
},
"name": "Temp1.txt",
"description": null,
"id": "1002",
"last_modified": "2016-10-27T12:20:59Z"
},
{
"type": "attachment",
"creation_time": "2016-10-27T11:01:09Z",
"version_stamp": 1,
"author": {
"type": "workspace_user",
"full_name": "MyAPIAccess",
"name": "MyAPIAccess_rnj70jxlvk6d3sqn2n227y6xk",
"id": "1003"
},
"name": "This page will soon be discontinued.docx",
"description": null,
"id": "1001",
"last_modified": "2016-10-27T11:01:09Z"
}]
}
添付ファイルインスタンスのバイナリコンテンツを取得する例添付ファイルに対するこのGET要求は、添付ファイルのデータなしで、添付ファイルのバイナリコンテンツのみを返します。コンテンツは、次のコンテンツを含むテキストファイルです。 “text file testing”
GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/attachments/4003
*** Response ***
HTTP/1.1 200 OK
Content-Encoding: gzip
Content-Type: text/plain
Date: Mon, 27 Mar 2014 12:11:05 GMT
Server: MyServer
text file testing
参照情報:
