機械翻訳について
  1. ドキュメント用REST API
  2. タスク
  3. ファイル

ファイルのHTML5プレビューの取得

get

/documents/api/1.2/files/{fileId}/previewPath

指定されたファイルのHTML5プレビューを生成し、それにアクセスするために使用できるパスを返します。


プレビューできるファイルのタイプは次のとおりです(同様の形式もサポートされている場合があります):

  • ほとんどのイメージ(bmp、jpg、tif、gif、png)
  • Officeファイル(doc、docx、dot、dotx、xls、xlsx、xls、xlst、pot、potx、ppt、pptx)
  • テキスト・ファイル(txt、scripts、source code)
  • AutoCAD図面
  • Adobe PDFファイル
  • インターネット・ファイル(html、電子メール)

ビデオ・フォーマットのプレビューは生成できないことに注意してください。

リクエスト

サポートされるメディア・タイプ
パス・パラメータ
問合せパラメータ

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

  • trueの場合、この呼び出しはHTML5プレビューが作成されるまで戻りません。 このパラメータを使用すると、この呼び出しの戻りは遅れますが、プレビューがシステムで完全に使用可能になります。 デフォルトは、falseです。

ヘッダー・パラメータ

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

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

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

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

トップに戻る

レスポンス

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

200レスポンス

リクエストが処理されました。

本文 ()
ルート・スキーマ: FileHtml5PreviewResponse
タイプ: object
レスポンス本文には、生成されたHTML5パスに関する情報が含まれます。
ソースを表示
レスポンスの例(application/json)
{
    "errorCode":"0",
    "id":"D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "previewUrl":"http://Service1-AttTenant1.slc04ymr.us.oracle.com:12020/documents/fileview/D03175B85C8EAA3B6F2BC6A84EE870070A1A2B7FEACF/1/preview/html5/pvw.html",
    "version":"1",
    "type":"file"
}

403レスポンス

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

404レスポンス

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

トップに戻る

例

次の例では、このファイルのHTML5プレビューを生成し、それにアクセスするためのパスを提供します。

GET .../files/D03175B85C8EAA3B6F2BC6A84EE870070A1A2B7FEACF/previewPath?version=1

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
"errorCode": "0",
"id": "D03175B85C8EAA3B6F2BC6A84EE870070A1A2B7FEACF",
"previewUrl": "http://Service1-AttTenant1.slc04ymr.us.oracle.com:12020/documents/fileview/D03175B85C8EAA3B6F2BC6A84EE870070A1A2B7FEACF/1/preview/html5/pvw.html",
"type": "file",
"version": "1"
}

例2

次の例では、HTML5プレビューが生成されなかったときのエラー・メッセージを示します。

GET .../files/D512601281A52376A28F2D4CB5D17B95F47087F4E518/previewPath?version=1

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
    "errorCode": "-16",
    "errorKey": "!csUnableToGetDynamicConversionNew!csGeneratePreviewFailed",
    "errorMessage": "Unable to get dynamic conversion. Unable to generate preview images, no images created.",
    "errorType": "file",
    "id": "D512601281A52376A28F2D4CB5D17B95F47087F4E518",
    "title": "Unable to get dynamic conversion. Unable to generate preview images, no images created.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例3

次の例では、このファイルのHTML5プレビューを生成し、それにアクセスするためのパスを提供します。 このファイルは現在のユーザーが所有していない、または共有していないフォルダ構造の下にあるため、この例ではapplink IDを使用しています。 applink IDとアクセス・トークンはリクエスト・ヘッダーに送信されます。 

GET .../files/D110149C6BF6EF07A968CB78B5D17B95F47087F4E518/previewPath?version=1

リクエスト・ヘッダー

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

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "id": "D110149C6BF6EF07A968CB78B5D17B95F47087F4E518",
    "previewUrl": "http://service1-tenant2.myhost:19200/documents/link/app/fileview/LFCgbdYuDTDluTeDWFECI5Szz1C30tvWtOEgJYKv7C7rxZ2RUwfR8c-oTx-op_59W3mqF4l2Q852N25LdR8fy0A6J_Fw6XzirkJngtnspCuQoPYdtjBmwzCEym0ZQd2DpQ1pevDZ948RB7-pJN0JnIHg==/FnQ9vtFfq5aKFTR4P-T9ry3uJdJi9n9LBiPOXgOkTkRoQXqfmGHJMR2DGcbRGA5kUm00SXWPui8h__0yk6qybA==/D110149C6BF6EF07A968CB78B5D17B95F47087F4E518/1/preview/html5/pvw.html",
    "type": "file",
    "version": "1"
}
先頭に戻る