ドキュメント用REST API

機械翻訳について

レスポンシブ・ミディアム・イメージを取得

get

/documents/api/1.2/files/{fileId}/data/mediumImage

中規模のファイルのレンディションを取得します。返されるイメージは1024ピクセルよりも広くはありません。レンディションが作成されていない場合、このコールはレンディションを生成します。

リクエスト

サポートされるメディア・タイプ

application/json
application/xml

パス・パラメータ

fileId: string

ファイルのグローバル一意識別子(GUID)。 GUIDは、jpeg、png、gif、またはtiffイメージ用である必要があります。

問合せパラメータ

format(optional): string
返すイメージのタイプを指定します。次のタイプがサポートされています:
- jpegまたはjpgがjpegイメージを返します。これがデフォルト値です。
- webpはWebPイメージを返します。
version(optional): string

使用するファイルのバージョン番号を指定します。バージョンが指定されていない場合は、最新バージョンが使用されます。

ヘッダー・パラメータ

accessToken(optional): string

現在のユーザーに親フォルダまたはこのファイルにアクセスすることを許可するApplinkアクセス・トークン。このパラメータは、appLinkIDが使用されている場合は必須です。これはaccessTokenまたはAccessTokenとして使用できます。
appLinkID(optional): string

現在のユーザーに親フォルダまたはこのファイルにアクセスすることを許可するApplink ID。パラメータappLinkIDが使用されるときはいつでも、パラメータaccessTokenも提供されなければなりません。 appLinkIDまたはAppLinkIDとして使用できます。
dAccessCode(optional): string

保護されたパブリック・リンクを使用するために必要なアクセス・コード。次の形式のCookieヘッダーの一部として送信する必要があります: dAccessCode-<linkID>=<passcodeValue>
linkID(optional): string

現在のユーザーにこのファイルへのアクセスを許可する、パブリック・リンクのパブリック・リンクID。 linkIDまたはLinkIDとして使用できます。

トップに戻る

レスポンス

サポートされるメディア・タイプ

image/jpeg
image/webp

200レスポンス

応答イメージのバイナリ・データ・ストリーム。

403レスポンス

ユーザーにファイルIDに対する読み取りアクセス権がありません。

404レスポンス

ファイルIDが見つからないか、まれに変換されたイメージを返すことができません。

415 レスポンス

ファイルIDがjpeg、png、gif、またはtiffイメージではありません。

トップに戻る

例

次の例では、指定されたファイルの最新バージョンの中規模のjpegイメージを取得します。返されるイメージは1024ピクセルよりも広くはありません。ステータス・コードが成功を示す場合(200)、レスポンスにはイメージを含むデータ・ストリームが含まれます。

GET .../files/D21C7EAA30B5394DF4B3FAF223897F0989F871A58A5C/data/mediumImage

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

例2

次の例では、指定されたファイルのバージョン2の中規模のwebpイメージを取得します。返されるイメージは1024ピクセルよりも広くはありません。ステータス・コードが成功を示す場合(200)、レスポンスにはイメージを含むデータ・ストリームが含まれます。

GET .../files/D3E2C64C386901BFC239EB7D394A94AF203799A93B9/data/mediumImage?version=2&format=webp

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

例3

次の例では、指定されたファイルのバージョン2の中規模のwebpイメージを取得しますが、そのファイルは現在のユーザーが所有していない、または現在のユーザーと共有していないフォルダ構造の下にあります。アクセス拒否エラー・メッセージが返されます。

GET .../files/D3E2C64C386901BFC239EB7D394A94AF203799A93B9/data/mediumImage?version=2&format=webp

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

{
    "errorCode": "-20",
    "errorKey": "!csUnableToDownloadFile!csCloudItemInsufficientPrivileges,DefaultTenant.UserA,fFileGUID:DD3E2C64C386901BFC239EB7D394A94AF203799A93B9,GET_ALTERNATE_IMAGE",
    "errorMessage": "Unable to download file. User 'User AA' has insufficient privilege to access fFileGUID:DD3E2C64C386901BFC239EB7D394A94AF203799A93B9 with service GET_ALTERNATE_IMAGE.",
    "errorType": "file",
    "format": "webp",
    "id": "DD3E2C64C386901BFC239EB7D394A94AF203799A93B9",
    "rendition": "Medium",
    "title": "Unable to download file. User 'User AA' has insufficient privilege to access fFileGUID:DD3E2C64C386901BFC239EB7D394A94AF203799A93B9 with service GET_ALTERNATE_IMAGE.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例4

次の例では、指定されたファイルのバージョン2の中規模のwebpイメージを取得しますが、ファイルIDは無効です。

GET .../files/DD3B2C64C386901BFC239EB7D394A94AF203799A93B9/data/mediumImage?version=2&format=webp

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
    "errorCode": "-16",
    "errorKey": "!csUnableToDownloadFile!csSecurityValidationFailed!csFldDoesNotExist,DD3B2C64C386901BFC239EB7D394A94AF203799A93B9!csSystemError,\\!csFldDoesNotExist\\,DD3B2C64C386901BFC239EB7D394A94AF203799A93B9",
    "errorMessage": "Unable to download file. Security validation failed. 'DD3B2C64C386901BFC239EB7D394A94AF203799A93B9' does not exist. (System Error: 'DD3B2C64C386901BFC239EB7D394A94AF203799A93B9' does not exist.)",
    "errorType": "file",
    "format": "webp",
    "id": "DD3B2C64C386901BFC239EB7D394A94AF203799A93B9",
    "rendition": "Medium",
    "title": "Unable to download file. Security validation failed. 'DD3B2C64C386901BFC239EB7D394A94AF203799A93B9' does not exist. (System Error: 'DD3B2C64C386901BFC239EB7D394A94AF203799A93B9' does not exist.)",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "version": "2"
}

例5

次の例では、指定されたファイルのバージョン4の中規模のjpegを取得します。返されるイメージは1024ピクセルよりも広くはありません。ステータス・コードが成功を示す場合(200)、レスポンスにはjpegイメージを含むデータ・ストリームが含まれます。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあるため、この例では、アクセス・コードで保護されているパブリック・リンクIDを使用します。アクセス・コード( test12345)は、Cookieの一部としてリクエスト・ヘッダーに発行されます。

GET .../files/D3E2C64C386901BFC239EB7D394A94AF203799A93B9/data/mediumImage?version=4

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

例6

次の例では、指定されたファイルのバージョン2の中規模のjpegを取得します。返されるイメージは1024ピクセルよりも広くはありません。ステータス・コードが成功を示す場合(200)、レスポンスにはjpegイメージを含むデータ・ストリームが含まれます。このファイルは現在のユーザーが所有していない、または共有していないフォルダ構造の下にあるため、この例ではapplink IDを使用しています。 applink IDとアクセス・トークンはリクエスト・ヘッダーに送信されます。

GET .../files/D3E2C64C386901BFC239EB7D394A94AF203799A93B9/data/mediumImage?version=2

リクエスト・ヘッダー

appLinkID: LF5Bxj4TPo_p4n4qWn0tbKTicR2cTUJKv7X_ng9E7ry93rRuDokPqS1d6-wKwhb_wtcGYFDsI_cNMxeKQ-HR-FXQhiVoGRTYM_MPZY8qpICfYU94mmnMjM_cvsRhKMzc0NJgvwEJfqqDwPsAVrhc8cmg==
accessToken: 352FpiMmW66PeYI1Gh5b83I9CXRwZhLfYAu4TXdqpzD8uNKUBMZVVJ3ZvivUW8kQ

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

例7

次の例では、指定されたファイルIDの最新バージョンの中規模Webを取得しますが、ファイルIDはjpeg、png、gifまたはtiffイメージではありません。したがって、"Unsupported Media Type"エラーが返されます。

GET .../files/DAFEF814943F5A3A1E6AC6AED394A94AF203799A93B9/data/mediumImage?format=webp

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 415

JSONレスポンス

{
    "errorCode": "-30",
    "errorKey": "!csUnableToDownloadFile!csZipRenditionNotAnImage",
    "errorMessage": "Unable to download file. Responsive images cannot be created for non image files.",
    "title": "Unable to download file. Responsive images cannot be created for non image files.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

先頭に戻る