ドキュメント用REST API

ファイル・レンディション生成

post

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

イメージ・ベースのプレビュー(ページ・レンディション)がない指定したファイルのイメージ・ベースのプレビュー(ページ・レンディション)を生成します。イメージ・ベースのプレビュー(またはレンディション)は、ファイルの各ページがイメージに変換されるファイル・コンテンツの表示可能な表現です。すべてのファイル・タイプがイメージ・ベースのプレビュー(ページ・レンディション)をサポートしているわけではありません。

レンディションを含めることができるファイルのタイプには、次のものがあります(同様の形式もサポートされている場合があります):

ほとんどのイメージ(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、電子メール)

ビデオ形式のプレビュー(ページ・レンディション)は生成できないことに注意してください。

リクエスト

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

application/json
application/xml

パス・パラメータ

fileId: string

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

問合せパラメータ

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として使用できます。

トップに戻る

レスポンス

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

application/octet-stream

200レスポンス

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

ルート・スキーマ: FileGenPagesResponse

タイプ: object

レスポンス本文には、イメージ・ベース・プレビュー(ページ・レンディション)の作成に関する情報が含まれます。

ソースを表示

errorCode(optional): number

エラー・コードがゼロ(0)の場合は、エラーなしです
id(optional): string

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

アイテム・タイプfile。

{
    "description":"The response body includes information about creating an image base preview (page renditions).",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the file."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>file</code>."
        },
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

レスポンスの例(application/json)

{
    "id":"D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type":"file",
    "errorCode":"0"
}

403レスポンス

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

404レスポンス

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

トップに戻る

例

次の例では、ページ・レンディションがない指定したファイルのためにページ・レンディションを生成します。レンディションはファイルの内容の参照可能な表示です。すべてのファイル・タイプがページ・レンディションをサポートするわけではありません。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあるため、この例では、パブリック・リンクIDを使用します。

POST .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/pages

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

{
    "version": "1"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "id": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type": "file"
}

例2

POST .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/pages

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

リクエスト本文

{
    "version": "1"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "id": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type": "file"
}

例3

次の例では、ページ・レンディションがない指定したファイルのためのページ・レンディションの生成をリクエストします。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあるため、アクセス拒否エラー・メッセージが返されます。

POST .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/page

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "version": "1"
}

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

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

例4

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

POST .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/pages

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

{
    "version": "1"
}

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

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

例5

次の例では、ページ・レンディションがない指定したファイルのためにページ・レンディションを生成します。レンディションはファイルの内容の参照可能な表示です。すべてのファイル・タイプがページ・レンディションをサポートするわけではありません。このファイルは現在のユーザーが所有していない、または共有していないフォルダ構造の下にあるため、この例ではapplink IDを使用しています。 applink IDとアクセス・トークンはリクエスト・ヘッダーに送信されます。

POST .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/pages

リクエスト・ヘッダー

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

リクエスト本文

{
    "version": "1"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "id": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
    "type": "file"
}

先頭に戻る