ドキュメント用REST API

機械翻訳について

サムネイル取得

get

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

ドキュメントの先頭ページのサムネイル・イメージを取得します。ドキュメント・レンディションが生成されていない場合、このコールによってドキュメントの先頭ページのサムネイル・イメージが生成されます。

リクエスト

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

application/json
application/xml

パス・パラメータ

fileId: string

ファイルのグローバル一意識別子(GUID)。

問合せパラメータ

version(optional): string

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

ヘッダー・パラメータ

Range(optional): string
標準のHTTP Rangeヘッダーを使用すると、クライアントはファイル全体ではなくファイルの一部をストリーミングできます。 Rangeヘッダーの値は、次のいずれかの形式にできます:
- bytes= startByte - endByte
  たとえば、最初の500バイトを受信するには、bytes=0-500を使用
- bytes= skipBytes-
  たとえば、最初の500バイトをスキップするには、bytes=500-を使用
- bytes=-lastBytes
  たとえば、最後の500バイトを受信するには、bytes=-500を使用
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として使用できます。

トップに戻る

レスポンス

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

application/octet-stream

200レスポンス

ファイル・コンテンツの完全なデータ・ストリーム。

206レスポンス

ファイル・コンテンツの部分的なデータ・ストリーム。

403レスポンス

ユーザーに読取り権限がない場合は禁止されています。

404レスポンス

ファイルIDが見つかりません。

416 レスポンス

リクエストされた範囲を満たすことができません。

トップに戻る

例

次の例は、指定したドキュメント・ファイルの先頭ページのサムネイル・イメージを取得します。ステータス・コードが成功を示している場合(200)、レスポンスにはサムネイル・イメージを含むデータ・ストリームが含まれます。

GET .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/data/thumbnail?version=1

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

例2

次の例は、指定したドキュメント・ファイルの先頭ページのサムネイル・イメージを取得します。ステータス・コードが成功(200)を示す場合、レスポンスにはサムネイル・イメージを含むデータ・ストリームが含まれます。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあるため、この例では、パブリック・リンクIDを使用します。

GET .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/data/thumbnail?version=1

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

例3

次の例は、指定したドキュメント・ファイルの先頭ページのサムネイル・イメージを取得します。ステータス・コードが成功(200)を示す場合、レスポンスにはサムネイル・イメージを含むデータ・ストリームが含まれます。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあるため、この例では、アクセス・コードで保護されているパブリック・リンクIDを使用します。アクセス・コード( test12345)は、Cookieの一部としてリクエスト・ヘッダーに発行されます。

GET .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/data/thumbnail?version=1

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

例4

次の例では、指定したドキュメント・ファイルの先頭ページのサムネイル・イメージの取得をリクエストします。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあるため、アクセス拒否エラー・メッセージが返されます。

GET .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/data/thumbnail?version=1

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

{
    "errorCode": "-20",
    "errorKey": "!csUnableToDownloadFile!csCloudItemInsufficientPrivileges,User BB,fFileGUID:D3C1C1F319CFE6B102095C5DT0000000000100000001,GET_THUMBNAIL",
    "errorMessage": "Unable to download file. User 'User BB' has insufficient privilege to access fFileGUID:D3C1C1F319CFE6B102095C5DT0000000000100000001 with service GET_THUMBNAIL.",
    "errorType": "file",
    "id": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "title": "Unable to download file. User 'User BB' has insufficient privilege to access fFileGUID:D3C1C1F319CFE6B102095C5DT0000000000100000001 with service GET_THUMBNAIL.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "version": "2"
}

例5

次の例では、指定したドキュメント・ファイルの先頭ページのサムネイル・イメージの取得をリクエストします。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあります。また、アクセス・コードで保護されているパブリック・リンクのみを使用可能です。アクセス・コードがリクエストの一部として送信されなかったため、エラーが返されます。

GET .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/data/thumbnail?version=1

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

{
    "errorCode": "-18",
    "errorKey": "!csUnableToDownloadFile!csAccessCodeRequiredForLinkAccess",
    "errorMessage": "Unable to download file. The access code must be provided to access the link.",
    "errorType": "file",
    "id": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "title": "Unable to download file. The access code must be provided to access the link.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "version": "2"
}

例6

次の例は、指定したドキュメント・ファイルの先頭ページのサムネイル・イメージを取得します。ステータス・コードが成功を示している場合(200)、レスポンスにはサムネイル・イメージを含むデータ・ストリームが含まれます。このファイルは現在のユーザーが所有していない、または共有していないフォルダ構造の下にあるため、この例ではapplink IDを使用しています。 applink IDとアクセス・トークンはリクエスト・ヘッダーに送信されます。

GET .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/data/thumbnail?version=1

リクエスト・ヘッダー

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

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

先頭に戻る