Box Developerドキュメント
ログイン
 

    ファイルのすべてのレプリゼンテーションのリストの取得

    ガイド レプリゼンテーション ファイルのすべてのレプリゼンテーションのリストの取得

    ファイルのすべてのレプリゼンテーションのリストの取得

    ファイルに使用できるレプリゼンテーションを確認するには、representationsフィールドのリクエスト中にGET /files/:idエンドポイントを呼び出します。

    curl https://api.box.com/2.0/files/123?fields=representations \
    -H "authorization: Bearer ACCESS_TOKEN"

    このレスポンスには、次の形式でレプリゼンテーションのリストが含まれます。

    ...
{
  "info": {
    "url": "https://api.box.com/2.0/internal_files/123/versions/345/representations/jpg_thumb_32x32"
  },
  "properties": {
      "dimensions": "32x32",
      "paged": "false",
      "thumb": "true"
  },
  "representation": "jpg"
}
...

    レスポンスのフィールド

    どのレプリゼンテーションにも一連のプロパティとレプリゼンテーションのタイプが含まれます。

    • dimensionsフィールド (省略可) は、ファイルのサイズをピクセル単位の幅と高さで表します。

    • pagedフィールド (省略可) は、このレプリゼンテーションがページ割りされたドキュメントかどうかを指定します。画像やPDFによっては、ページ割りされたドキュメントになることがよくあります。

    • thumbフィールド (省略可) は、このレプリゼンテーションがファイルのサムネイルとして適しているかどうかを指定します。