ドキュメント用REST API

機械翻訳について

ファイル・バージョン取得

get

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

指定したファイルのバージョン情報を取得します。

リクエスト

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

application/json
application/xml

パス・パラメータ

fileId: string

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

ヘッダー・パラメータ

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レスポンス

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

ルート・スキーマ: FileVersionsResponse

タイプ: object

レスポンス本文には、移動操作に関する情報が含まれます。

ソースを表示

errorCode(optional): number

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

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

ファイル・バージョンのリスト。
name(optional): string

ファイル名。
parentID(optional): string

親フォルダのグローバル一意識別子(GUID)。親フォルダがユーザーのホーム・フォルダの場合、parentIDの値はselfです。
type(optional): string

アイテム・タイプfile。

{
    "description":"The response body includes information about the move operation.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the file."
        },
        "parentID":{
            "type":"string",
            "description":"<p>Globally unique identifier (GUID) for the parent folder. If the parent  folder is the user&#39;s home folder, the value for <code>parentID</code> is <code>self</code>.</p>"
        },
        "name":{
            "type":"string",
            "description":"File name."
        },
        "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 File Versions.",
            "items":{
                "$ref":"#/definitions/FileDefinition"
            }
        }
    }
}

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

タイプ: array

ファイル・バージョンのリスト。

ソースを表示

Array of: object FileDefinition

ファイル情報

{
    "type":"array",
    "description":"List of File Versions.",
    "items":{
        "$ref":"#/definitions/FileDefinition"
    }
}

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

タイプ: object

ファイル情報

ソースを表示

createdBy(optional): object User

ユーザー情報
createdTime(optional): string

ファイルの作成日。
id(optional): string

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

ファイルのファイル形式
modifiedBy(optional): object User

ユーザー情報
modifiedTime(optional): string

ファイルの最終更新日
name(optional): string

ファイル名。
ownedBy(optional): object User

ユーザー情報
parentID(optional): string

親フォルダのグローバル一意識別子(GUID)。親フォルダがユーザーのホーム・フォルダの場合、parentIDの値はselfです。
reservationTime(optional): string

ファイルが予約された時刻(ファイルが予約されていない場合、レスポンス・データから除外されます)
reservedBy(optional): object User

ユーザー情報
size(optional): string

ファイルのサイズ(バイト単位)。
type(optional): string

アイテム・タイプfile。
version(optional): string

ファイルのバージョン。

{
    "description":"File information",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the file."
        },
        "parentID":{
            "type":"string",
            "description":"<p>Globally unique identifier (GUID) for the parent folder. If the parent folder is the user&#39;s home folder, the value for <code>parentID</code> is <code>self</code>.</p>"
        },
        "name":{
            "type":"string",
            "description":"File name."
        },
        "mimeType":{
            "type":"string",
            "description":"File format of the file."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>file</code>."
        },
        "size":{
            "type":"string",
            "description":"Size of the file in bytes."
        },
        "version":{
            "type":"string",
            "description":"File version."
        },
        "createdTime":{
            "type":"string",
            "description":"File creation date."
        },
        "modifiedTime":{
            "type":"string",
            "description":"File last modified date."
        },
        "reservationTime":{
            "type":"string",
            "description":"Time the file was reserved (excluded from response data if the file is not reserved)."
        },
        "createdBy":{
            "$ref":"#/definitions/User"
        },
        "ownedBy":{
            "$ref":"#/definitions/User"
        },
        "modifiedBy":{
            "$ref":"#/definitions/User"
        },
        "reservedBy":{
            "$ref":"#/definitions/User"
        }
    }
}

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

タイプ: object

ユーザー情報

ソースを表示

displayName(optional): string

ユーザーの表示名
id(optional): string

ユーザーのグローバル一意識別子(GUID)。
loginName(optional): string

ユーザーのログイン名。
type(optional): string

アイテム・タイプuser。

{
    "description":"User information",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the user."
        },
        "displayName":{
            "type":"string",
            "description":"The display name for the user."
        },
        "loginName":{
            "type":"string",
            "description":"The login name for the user."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>user</code>."
        }
    }
}

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

{
    "id":"D574378400573ED9D62B3195T0000000000100000001",
    "parentID":"FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "name":"example2.txt",
    "type":"file",
    "errorCode":"0",
    "items":[
        {
            "id":"D574378400573ED9D62B3195T0000000000100000001",
            "parentID":"FB4CD874EF94CD2CC1B60B72T0000000000100000001",
            "name":"example2.txt",
            "type":"file",
            "size":"13",
            "version":"1",
            "createdTime":"2014-02-21T21:15:57Z",
            "modifiedTime":"2014-02-21T21:18:49Z",
            "createdBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            },
            "ownedBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            },
            "modifiedBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            }
        }
    ]
}

403レスポンス

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

404レスポンス

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

トップに戻る

例

次の例では、指定したファイルの各バージョンのファイル定義情報が返されます。

GET .../files/D574378400573ED9D62B3195T0000000000100000001/versions

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "name": "example2.txt",
    "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "type": "file",
    "items": [
        {
            "type": "file",
            "id": "D574378400573ED9D62B3195T0000000000100000001",
            "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
            "name": "example2.txt",
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "modifiedTime": "2014-02-21T21:18:49Z",
            "createdBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "version": "1",
            "createdTime": "2014-02-21T21:15:57Z",
            "size": "13"
        },
        {
            "type": "file",
            "id": "D574378400573ED9D62B3195T0000000000100000001",
            "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
            "name": "example2.txt",
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "modifiedBy": "{
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
 
            "modifiedTime": "2014-02-21T21:18:49Z",
            "createdBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "version": "2",
            "createdTime": "2014-02-21T21:17:13Z",
            "size": "13"
        },
        {
            "type": "file",
            "id": "D574378400573ED9D62B3195T0000000000100000001",
            "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
            "name": "example2.txt",
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "modifiedTime": "2014-02-21T21:18:49Z",
            "createdBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "version": "3",
            "createdTime": "2014-02-21T21:18:20Z",
            "size": "13"
        },
        {
            "type": "file",
            "id": "D574378400573ED9D62B3195T0000000000100000001",
            "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
            "name": "example2.txt",
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "modifiedTime": "2014-02-21T21:18:49Z",
            "createdBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "version": "4",
            "createdTime": "2014-02-21T21:18:48Z",
            "size": "13"
        }
    ]
}

例2

次の例では、指定したファイルの各バージョンのファイル定義情報が返されます。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあるため、この例では、パブリック・リンクIDを使用します。

GET .../files/D574378400573ED9D62B3195T0000000000100000001/versions

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "name": "idcTestNewFile1KB.txt",
    "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518",
    "type": "file",
    "items": [
        {
            "type": "file",
            "id": "D574378400573ED9D62B3195T0000000000100000001",
            "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518",
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User BB",
                "loginName": "userBBLoginName",
                "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
                "type": "user"
            },
            "modifiedTime": "2016-06-30T21:06:49Z",
            "name": "idcTestNewFile1KB.txt",
            "createdBy": {
                "displayName": "User BB",
                "loginName": "userBBLoginName",
                "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
                "type": "user"
            },
            "version": "8",
            "createdTime": "2016-06-30T21:06:49Z",
            "mimeType": "text/plain",
            "size": "33"
        },
        {
            "type": "file",
            "id": "D574378400573ED9D62B3195T0000000000100000001",
            "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518",
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User BB",
                "loginName": "userBBLoginName",
                "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
                "type": "user"
            },
            "modifiedTime": "2016-06-30T21:06:45Z",
            "name": "idcTestNewFile1KB.txt",
            "createdBy": {
                "displayName": "User BB",
                "loginName": "userBBLoginName",
                "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
                "type": "user"
            },
            "version": "7",
            "createdTime": "2016-06-30T21:06:45Z",
            "mimeType": "text/plain",
            "size": "33"
        }
    ]
}

例3

次の例では、指定したファイルの各バージョンのファイル定義情報が返されます。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあるため、この例では、アクセス・コードで保護されているパブリック・リンクIDを使用します。アクセス・コード( test12345)は、Cookieの一部としてリクエスト・ヘッダーに発行されます。

GET .../files/D574378400573ED9D62B3195T0000000000100000001/versions

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "name": "idcTestNewFile1KB.txt",
    "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518",
    "type": "file",
    "items": [
        {
            "type": "file",
            "id": "D574378400573ED9D62B3195T0000000000100000001",
            "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518",
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User BB",
                "loginName": "userBBLoginName",
                "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
                "type": "user"
            },
            "modifiedTime": "2016-06-30T21:06:49Z",
            "name": "idcTestNewFile1KB.txt",
            "createdBy": {
                "displayName": "User BB",
                "loginName": "userBBLoginName",
                "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
                "type": "user"
            },
            "version": "8",
            "createdTime": "2016-06-30T21:06:49Z",
            "mimeType": "text/plain",
            "size": "33"
        },
        {
            "type": "file",
            "id": "D574378400573ED9D62B3195T0000000000100000001",
            "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518",
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User BB",
                "loginName": "userBBLoginName",
                "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
                "type": "user"
            },
            "modifiedTime": "2016-06-30T21:06:45Z",
            "name": "idcTestNewFile1KB.txt",
            "createdBy": {
                "displayName": "User BB",
                "loginName": "userBBLoginName",
                "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
                "type": "user"
            },
            "version": "7",
            "createdTime": "2016-06-30T21:06:45Z",
            "mimeType": "text/plain",
            "size": "33"
        }
    ]
}

例4

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

GET .../files/D574378400573ED9D62B3195T0000000000100000001/versions

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

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

例5

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

GET .../files/D574378400573ED9D62B3195T0000000000100000001/versions

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

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

例6

次の例では、指定したファイルの各バージョンのファイル定義情報が返されます。このファイルは現在のユーザーが所有していない、または共有していないフォルダ構造の下にあるため、この例ではapplink IDを使用しています。 applink IDとアクセス・トークンはリクエスト・ヘッダーに送信されます。

GET .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/versions

リクエスト・ヘッダー

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

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "id": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
    "name": "fileViaApplink-renamed.txt",
    "parentID": "FDC22B65E850730CAA60AF83B5D17B95F47087F4E518",
    "type": "file",
    "items": [
        {
            "type": "file",
            "id": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
            "parentID": "FDC22B65E850730CAA60AF83B5D17B95F47087F4E518",
            "ownedBy": {
                "displayName": "User AA",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "loginName": "userAALoginName",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User BB",
                "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
                "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
                "type": "user"
            },
            "modifiedTime": "2017-06-26T15:29:07Z",
            "name": "fileViaApplink-renamed.txt",
            "createdBy": {
                "displayName": "User BB",
                "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
                "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
                "type": "user"
            },
            "version": "2",
            "createdTime": "2017-06-26T15:29:07Z",
            "mimeType": "text/plain",
            "size": "29"
        },
        {
            "type": "file",
            "id": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
            "parentID": "FDC22B65E850730CAA60AF83B5D17B95F47087F4E518",
            "ownedBy": {
                "displayName": "User AA",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "loginName": "userAALoginName",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User BB",
                "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
                "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
                "type": "user"
            },
            "modifiedTime": "2017-06-26T15:29:00Z",
            "name": "fileViaApplink.txt",
            "createdBy": {
                "displayName": "User BB",
                "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
                "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
                "type": "user"
            },
            "version": "1",
            "createdTime": "2017-06-26T15:29:00Z",
            "mimeType": "text/plain",
            "size": "29"
        }
    ]
}

先頭に戻る