ドキュメント用REST API

機械翻訳について

リストのレンディション

get

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

ファイル・バージョンのシステム生成レンディションまたはユーザー・アップロード・レンディションをリストします。

リクエスト

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

application/json
application/xml

パス・パラメータ

fileId: string

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

問合せパラメータ

renditionType(optional): string

取得するレンディション・タイプを指定します。サムネイル・レンディションおよびページ・レンディションにはrenditionType=systemを使用します。カスタム・アップロードされたレンディションにはrenditionType=uploadedを使用します。
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/json
application/xml

200レスポンス

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

ルート・スキーマ : FileListCustomRenditionResponse

タイプ: object

レスポンス本文には、レンディションのリストに関する情報が含まれます。

ソースを表示

errorCode(optional): number

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

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

レンディションのリスト。
type(optional): string

アイテム・タイプfile。

{
    "description":"The response body includes information about the list of 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."
        },
        "items":{
            "type":"array",
            "description":"List of renditions.",
            "items":{
                "$ref":"#/definitions/FileCustomRenditionDefinition"
            }
        }
    }
}

ネストされたスキーマ: items

タイプ: array

レンディションのリスト。

ソースを表示

Array of: object FileCustomRenditionDefinition

レンディション情報

{
    "type":"array",
    "description":"List of renditions.",
    "items":{
        "$ref":"#/definitions/FileCustomRenditionDefinition"
    }
}

ネストされたスキーマ : FileCustomRenditionDefinition

タイプ: object

レンディション情報

ソースを表示

description(optional): string

レンディションの説明。
name(optional): string

レンディション名
originalName(optional): string

元のファイル名をレンディションします。
path(optional): string

レンディション・パス。
type(optional): string

アイテム・タイプrendition。

{
    "description":"Rendition information",
    "properties":{
        "type":{
            "type":"string",
            "description":"Item type <code>rendition</code>."
        },
        "name":{
            "type":"string",
            "description":"Rendition name."
        },
        "description":{
            "type":"string",
            "description":"Rendition description."
        },
        "path":{
            "type":"string",
            "description":"Rendition path."
        },
        "originalName":{
            "type":"string",
            "description":"Rendition original file name."
        }
    }
}

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

{
    "errorCode":"0",
    "id":"D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type":"file",
    "items":[
        {
            "type":"rendition",
            "name":"small",
            "description":"jellyfish small custom rendition",
            "path":"small.jpg",
            "originalName":"Jellyfish_small.jpg"
        },
        {
            "type":"rendition",
            "name":"crop",
            "description":"jellyfish crop custom rendition",
            "path":"crop.jpg",
            "originalName":"Jellyfish_crop.jpg"
        }
    ]
}

403レスポンス

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

404レスポンス

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

トップに戻る

例

次の例では、指定されたファイルのリビジョン1にアップロードされたカスタム・レンディションをリストします。

GET .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/data/renditions?renditionType=uploaded&version=1

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "id": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type": "file",
    "items": [
        {
            "type": "rendition",
            "name": "small",
            "description": "jellyfish_small_custom_rendition",
            "path": "small.jpg",
            "originalName": "Jellyfish_small.jpg"
        },
        {
            "type": "rendition",
            "name": "crop",
            "description": "jellyfish_crop_custom_rendition",
            "path": "crop.jpg",
            "originalName": "Jellyfish_crop.jpg"
        },
        {
            "type": "rendition",
            "name": "smallv2",
            "description": "jellyfish small custom rendition v2",
            "path": "smallv2.jpg",
            "originalName": "smallJellyfish.jpg"
        },
        {
            "type": "rendition",
            "name": "smallv3",
            "description": "jellyfish small custom rendition v3",
            "path": "smallv3.jpg",
            "originalName": "smallJellyfish.jpg"
        },
        {
            "type": "rendition",
            "name": "smallv4",
            "description": "jellyfish small custom rendition v4",
            "path": "smallv4.jpg",
            "originalName": "smallJellyfish.jpg"
        }
    ]
}

例2

次の例では、指定されたファイルのリビジョン1にアップロードされたシステム・レンディションをリストします。

GET .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/data/renditions?renditionType=system&version=1

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "id": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type": "file",
    "items": [
        {
            "type": "rendition",
            "name": "page1",
            "description": "image for page1",
            "path": "pages.jpg",
            "originalName": "SOMETHING00004370530000003400-page1.jpg"
        },
        {
            "type": "rendition",
            "name": "thumbnail1",
            "description": "image for thumbnail1",
            "path": "thumbnails.png",
            "originalName": "SOMETHING00004370530000003400-thumbnail1.jpg"
        },
        {
            "type": "rendition",
            "name": "PageInfo",
            "description": "image for PageInfo",
            "path": "pageinfo.hda",
            "originalName": "SOMETHING00004370530000003400-PageInfo.jpg"
        }
    ]
}

例3

次の例では、指定されたファイルのリビジョン1にアップロードされたカスタム・レンディションをリストします。このファイルは現在のユーザーが所有していない、または共有していないフォルダ構造の下にあるため、この例ではapplink IDを使用しています。 applink IDとアクセス・トークンはリクエスト・ヘッダーに送信されます。

GET .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/data/renditions?renditionType=uploaded&version=1

リクエスト・ヘッダー

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

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "id": "D68C8A7282DA5F389E3B009F98503556E71E89DE95CC",
    "type": "file",
    "items": [
        {
            "type": "rendition",
            "name": "applinkRendition",
            "description": "custom rendition via applink",
            "path": "applinkRendition.txt",
            "originalName": "appLinkCustomRendition.txt"
        }
    ]
}

先頭に戻る