ドキュメント用REST API

機械翻訳について

ファイル編集

put

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

指定したファイルの名前を変更します。

リクエスト

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

application/json
application/xml

パス・パラメータ

fileId: string

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

ヘッダー・パラメータ

accessToken(optional): string

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

現在のユーザーに親フォルダまたはこのファイルにアクセスすることを許可するApplink ID。パラメータappLinkIDが使用されるときはいつでも、パラメータaccessTokenも提供されなければなりません。働くには、このapplinkは、少なくともコントリビュータ・ロールが付与されていなければなりません。 appLinkIDまたはAppLinkIDとして使用できます。
dAccessCode(optional): string

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

現在のユーザーにこのファイルへのアクセスを許可する、パブリック・リンクのパブリック・リンクID。機能させるには、このパブリック・リンクにコントリビュータ・ロールが付与されている必要があります。 linkIDまたはLinkIDとして使用できます。

リクエスト本文では、ファイル編集リクエストの詳細を定義します。必須の属性はありません。

ルート・スキーマ: FileEditBody

タイプ: object

リクエスト本文では、ファイル編集リクエストの詳細を定義します。必須の属性はありません。

ソースを表示

name(optional): string

(オプション)ファイルに割り当てる名前を指定します。

{
    "description":"<p>The request body defines details of the edit file request. There are no required attributes.</p>",
    "properties":{
        "name":{
            "type":"string",
            "description":"(Optional) Specify the name to assign to the file."
        }
    }
}

リクエストの例(application/json)

{
    "name":"filev4.txt"
}

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

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

ルート・スキーマ: FileResponse

タイプ: object

レスポンス本文には、ファイルに関する情報が含まれます。

ソースを表示

errorCode(optional): number

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

{
    "description":"The response body includes information about the file.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/FileDefinition"
        }
    ],
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

すべてに一致

ソースを表示

object FileDefinition

ファイル情報

{
    "description":"The response body includes information about the file.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/FileDefinition"
        }
    ],
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

ネストされたスキーマ: 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":"filev4.txt",
    "type":"file",
    "size":"13",
    "version":"4",
    "createdTime":"2014-02-21T21:32:37Z",
    "modifiedTime":"2014-02-21T21:32:37Z",
    "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"
    },
    "errorCode":"0"
}

400レスポンス

リクエスト・パラメータが正しい形式ではありません。

403レスポンス

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

404レスポンス

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

トップに戻る

例

次の例では、指定したファイルの名前を変更します。

PUT .../files/D574378400573ED9D62B3195T0000000000100000001

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "name": "filev4.txt"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "createdBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "createdTime": "2014-02-21T21:15:57Z",
    "errorCode": "0",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",   
        "type": "user"
    },
    "modifiedTime": "2014-02-21T21:21:27Z",
    "name": "filev4.txt",
    "ownedBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",        
        "type": "user"
    },
    "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "size": "13",
    "type": "file",
    "version": "4"
}

例2

次の例では、指定したファイルの名前を変更します。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあるため、この例では、パブリック・リンクIDを使用します。

PUT .../files/D574378400573ED9D62B3195T0000000000100000001

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

{
    "name": "filev4.txt"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "createdBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "createdTime": "2014-02-21T21:15:57Z",
    "errorCode": "0",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "modifiedTime": "2014-02-21T21:21:27Z",
    "name": "filev4.txt",
    "ownedBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "size": "13",
    "type": "file",
    "version": "4"
}

例3

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

PUT .../files/D574378400573ED9D62B3195T0000000000100000001

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

リクエスト本文

{
    "name": "filev4.txt"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "createdBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "createdTime": "2014-02-21T21:15:57Z",
    "errorCode": "0",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "modifiedTime": "2014-02-21T21:21:27Z",
    "name": "filev4.txt",
    "ownedBy": {
        "displayName": "User AA",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "size": "13",
    "type": "file",
    "version": "4"
}

例4

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

PUT .../files/D574378400573ED9D62B3195T0000000000100000001

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "name": "filev4.txt"
}

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

{
    "errorCode": "-20",
    "errorKey": "!csFldUnableToEditDocumentLink!csCloudItemInsufficientPrivileges,User BB,fFileGUID:D574378400573ED9D62B3195T0000000000100000001,FLD_EDIT_FILE",
    "errorMessage": "Unable to edit foldering information. User 'User BB' has insufficient privilege to access fFileGUID:D574378400573ED9D62B3195T0000000000100000001 with service FLD_EDIT_FILE.",
    "errorType": "file",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "name": "filev4.txt",
    "title": "Unable to edit foldering information. User 'User BB' has insufficient privilege to access fFileGUID:D574378400573ED9D62B3195T0000000000100000001 with service FLD_EDIT_FILE.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例5

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

PUT .../files/D574378400573ED9D62B3195T0000000000100000001

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

{
    "name": "filev4.txt"
}

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

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

例6

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

PUT .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518

リクエスト・ヘッダー

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

リクエスト本文

{
    "name": "fileViaApplink-renamed.txt"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

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

先頭に戻る